Element
esri/form/elements/Element
Form elements define what should display within the FormTemplate elements. There are two specific element types:
The Element
class is a read-only base class which has no constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | The name of the class. more details | more details | Accessor | |
String | The element's description providing the purpose behind it. more details | more details | Element | |
String | A string value containing the field alias. more details | more details | Element | |
String | The type of form element displayed. more details | more details | Element | |
String | A reference to an Arcade expression that returns a boolean value. more details | more details | Element |
Property Details
The name of the class. The declared class name is formatted as
esri.folder.className
.
- description String
The element's description providing the purpose behind it.
- label String
A string value containing the field alias. This is not to Arcade expressions as the title is used instead.
- type Stringreadonly
The type of form element displayed.
Possible Values:"field"|"group"
- visibilityExpression String
A reference to an Arcade expression that returns a boolean value. When this expression evaluates to
true
, the element is displayed. When the expression evaluates tofalse
the element is not displayed. If no expression is provided, the default behavior is that the element is displayed. Care must be taken when defining a visibility expression for a non-nullable field i.e. to make sure that such fields either have default values or are made visible to users so that they can provide a value before submitting the form.The referenced expression must be what is defined in the form template's expressionInfos. It cannot be set inline within the element object.
Example:// Expression created within ExpressionInfos and is referenced in element const expression = new ExpressionInfo({ name: "alwaysHidden", expression: "1 == 0" }); // Reference an already-defined visibilityExpression set within the ExpressionInfos const fieldElement = new FieldElement({ type: "field", fieldName: "inspemail", label: "Email address", visibilityExpression: "alwaysHidden" });
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
* | 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 | Element | |
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | Element |
Method Details
- 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
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.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() guide topic for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.