TextContent | References | ArcGIS Maps SDK for JavaScript

import TextContent from "@arcgis/core/popup/content/TextContent.js";

Inheritance:: TextContent→Content→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.11

A TextContent popup element is used to define descriptive text as an element within a PopupTemplate's content. The text may reference values returned from a field attribute or an Arcade expression defined in a PopupTemplate's PopupTemplate.expressionInfos property.

popuptemplate-text-element .

See also

Examples

// Create the Text Content Element
// This element uses an attribute from the featurelayer which displays a sentence
// giving the total amount of trees value within a specified census block.
let textElement = new TextContent();
textElement.text = "There are {Point_Count} trees within census block {BLOCKCE10}";

// // Create the PopupTemplate
let template = new PopupTemplate({
  title: "Beverly Hills trees by block",
  outFields: ["*"],
  content: [textElement]
});

layer.popupTemplate = {
  content: [{
    type: "text", // Autocasts as new TextContent
    text: "The {expression/predominance-tree} species occurs more often"
      + " than other tree species in the area."
  }]
};

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`TextContentProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`text`	`string \| null \| undefined`
`type` readonly	`"text"`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

text

Property

Type: string | null | undefined

The formatted string content to display. This may contain a field name enclosed in {} (e.g. {FIELDNAME}), or an Arcade expression ExpressionInfo.name (e.g. {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.

Set the PopupTemplate.fieldInfos property for any fields that need to have number formatting within the text.

See also

PopupTemplate.expressionInfos

type

readonly Property

Type: "text"

The type of popup element displayed.

See also

Default value: "text"

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): TextContent`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter 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.

Parameters

Parameter	Type	Description	Required
json	`any`	A 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: any
Returns a new instance of this class.

clone

Method

Signature: clone (): TextContent

Creates a deep clone of the TextContent class.

Returns: TextContent
A deep clone of the TextContent instance.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.