Text
require(["esri/support/ContentElement/Text"], function(TextContentElement) { /* code goes here */ });esri/support/ContentElement/TextA TextContentElement is used to define descriptive text as an element within the PopupTemplate's content. The text may reference values returned from a field attribute or an Arcade expression.
.
- See also:
layer.popupTemplate.content = [{
// This element uses an attribute from the featurelayer which displays a sentence
//giving the total amount of trees value within a specified census block.
type: "text",
text: "There are {Point_Count} trees within census block {BLOCKCE10}"
}];layer.popupTemplate = {
content: [{
type: "text",
text: "The {expression/predominance-tree} species occurs more often"
+ " than other tree species in the area."
}]
};Constructors
- new Text(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | The name of the class. more details | more details | Accessor | |
| String | The formatted string content to display. more details | more details | Text | |
| String | The type of popup element displayed. more details | more details | Text |
Property Details
The name of the class. The declared class name is formatted as
esri.folder.className.
- textString
The formatted string content to display. This may contain a field name enclosed in
{}, such as{FIELDNAME}, or an Arcade expression name, referenced as{expression/EXPRESSIONNAME}. Text content may also leverage HTML tags such as<b></b>,<p></p>, and<table></table>for formatting the look and feel of the content.
- typeStringreadonly
The type of popup element displayed.
- Default Value:text
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| Text | Creates a deep clone of the TextContentElement class. more details | more details | Text | |
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. more details | more details | Text | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | Text |
Method Details
- clone(){Text}
Creates a deep clone of the TextContentElement class.
Returns:Type Description Text A deep clone of the TextContentElement instance.
- fromJSON(json){*}static
Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input
jsonparameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.Parameter:json ObjectA JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
Returns:Type Description * Returns a new instance of this class.
- toJSON(){Object}
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.