TextElementInput | API Reference | ArcGIS Maps SDK for JavaScript 4.32

See also

Property Overview

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

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
String\|null\|undefined	The input's description.	TextElementInput
String []	All Aracde expressions referenced, via string substitution, in the text content.	TextElementInput
String []	The names of all fields referenced, via string templates, in the text content.	TextElementInput
GroupInput\|null\|undefined	The group containing the text element input.	TextElementInput
String\|null\|undefined	The content of the TextElement, as a string in either plain-text (no formatting) or Markdown.	TextElementInput
String	The processed text, compiled and with template parameters replaced with values.	TextElementInput
String	Defines the format of the `text` property.	TextElementInput
String	The type of input.	TextElementInput

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

description Property description String |null |undefinedreadonly

The input's description.

expressionsUsed Property expressionsUsed String[]readonly

All Aracde expressions referenced, via string substitution, in the text content. The strings in this array are the names of the expressionInfo objects defining the expressions in the FormTemplate.

fieldsUsed Property fieldsUsed String[]readonly

The names of all fields referenced, via string templates, in the text content.

group Property group GroupInput |null |undefinedreadonly

The group containing the text element input.

rawText Property rawText String |null |undefined

The content of the TextElement, as a string in either plain-text (no formatting) or Markdown. See TextElement.text for details on supported Markdown features and on field and Arcade expression substitution.

text Property text String

The processed text, compiled and with template parameters replaced with values.

textFormat Property textFormat String

Defines the format of the text property.

Possible Values:"plain-text" |"markdown"

Default Value:"plain-text"

type Property type Stringreadonly

The type of input.

For TextElementInput the type is always "text".

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");