ESM: import TextElement from "@arcgis/core/form/elements/TextElement.js";
CDN: const TextElement = await $arcgis.import("@arcgis/core/form/elements/TextElement.js");
Class: @arcgis/core/form/elements/TextElement
A TextElement form element is used to define descriptive text as an element within a layer or FeatureForm FormTemplate and can be used to aid those entering or updating information. The text may reference values returned from a field attribute or an Arcade expression defined in a FormTemplate's expressionInfos property.
Example
// Create a plain-text element.
const textElement = new TextElement({
text: "Tree species: {COMMONNAME}."
});
// Create a markdown text element with italics and bold text.
const markdownTextElement = new TextElement({
textFormat: "markdown",
text: "_This text is italicized_ & **This text is bold.**"
});
layer.formTemplate = new FormTemplate({
title: "Plain-text and markdown text elements",
elements: [ textElement, markdownTextElement ]
}); new TextElement(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Show inherited properties Hide inherited properties
Property DetailsInherited
Property declaredClass Stringreadonly
The name of the class. The declared class name is formatted as esri.folder.className.
The formatted string content to display. This may contain a field name enclosed in {} (e.g. {FIELDNAME}), or an Arcade expression name (e.g. {expression/EXPRESSIONNAME}). Text content may also leverage Markdown formatting for these features:
Example
// This TextElement uses the markdown large heading.
const textElement = new TextElement({
textFormat: "markdown",
text: "##### This tree type is {COMMONNAME}."
}); textFormat String
Defines the format of the text property.
Possible Values:"plain-text" |"markdown"
Default Value:"plain-text"
type Stringreadonly
Indicates the type of form element. This will always be "text";
For TextElement the type is always "text".
A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate.
When this expression evaluates to true, the element is displayed. When the expression evaluates to false the element is not displayed. If no expression is provided, the element is always displayed. Care must be taken when defining a visibility expression for a non-nullable field as to make certain the specified field has either 1) a default value, or 2) is made visible to the end user to enter a value before submitting the form.
Example
// Expression created within ExpressionInfos and is referenced in element
const expression = new ExpressionInfo({
name: "alwaysHidden",
expression: "false"
});
// Reference an already-defined visibilityExpression set within the ExpressionInfos
const fieldElement = new FieldElement({
type: "field",
fieldName: "inspemail",
label: "Email address",
visibilityExpression: "alwaysHidden"
});
formTemplate.expressionInfos = [ expression ];
formTemplate.elements = [ fieldElement ];Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
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
Handles marked for removal once the object is destroyed.
groupKey *
optionalKey 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.
Creates a deep clone of the TextElement class.
Returns
Type Description TextElement A deep clone of the TextElement instance.Inherited
Method fromJSON(json){* |null |undefined}static
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.
Returns
Type Description * | null | undefined Returns a new instance of this class.Inherited
Method hasHandles(groupKey){Boolean}
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue 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");
}Inherited
Method removeHandles(groupKey)
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA 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");RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4