ESM: import Element from "@arcgis/core/form/elements/Element.js";
CDN: const Element = await $arcgis.import("@arcgis/core/form/elements/Element.js");
Class: @arcgis/core/form/elements/Element
Since: ArcGIS Maps SDK for JavaScript 4.16
Property Overview Any properties can be set, retrieved or listened to. See the Watch for changes topic.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 element's description providing the purpose behind it.
A string value containing the field alias. This should not be used for referencing fields in Arcade expressions. Rather, the service fieldName should be referenced.
type Stringreadonly
The type of form element to display.
Possible Value Description attachment An individual attachment element that defines an input for attachments in a FormTemplate. Note that this type is not fully supported in the FeatureForm widget and is not intended for use in the SDK. Support will be added in a future release. field An individual field element that defines the field within a layer or form'sformTemplate
. group Contains a grouping of field elements. relationship A relationship element defines a relationship between layers and tables and how they participate in the FeatureForm. text A text element defines descriptive text in a FormTemplate. utilityNetworkAssociations A utilityNetworkAssociations element defines how utility network associations participate in the form.
Possible Values:"attachment" |"field" |"group" |"relationship" |"text" |"utilityNetworkAssociations"
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)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.
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 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}
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.
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)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.
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