ExpressionInfo
require(["esri/form/ExpressionInfo"], function(ExpressionInfo) { /* code goes here */ });esri/form/ExpressionInfoThe ExpressionInfo class defines the Arcade expressions executed in a layer's FormTemplate. These expressions evaluate to either a number, string, array, or dictionary value on a feature-by-feature basis at runtime. The values display within the layer's form as if they are field values.
- See also:
Constructors
- new ExpressionInfo(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | The name of the class. more details | more details | Accessor | |
| String | An Arcade expression evaluating to either a string, number, dictionary, or array. more details | more details | ExpressionInfo | |
| String | The name of the expression. more details | more details | ExpressionInfo | |
| String | Indicates the return type of the Arcade expression. more details | more details | ExpressionInfo | |
| String | The title used to describe the value returned by the expression. more details | more details | ExpressionInfo |
Property Details
The name of the class. The declared class name is formatted as
esri.folder.className.
- expression String
An Arcade expression evaluating to either a string, number, dictionary, or array. This expression can reference field values using the
$featureglobal variable and perform mathematical calculations and logical evaluations at runtime.Example:// Set a simple string to a feature layer's formTemplate // referencing the value returned from an Arcade expression expressionInfo.expression = "{expression/per-asian}% of the people in this tract are Asian.";
- name String
The name of the expression. This is used to reference the value of the given
expressionin the FormTemplate property by wrapping it in curly braces and prefacing it withexpression/(e.g.{expression/expressionName}).
- returnType String
Indicates the return type of the Arcade expression.
Possible Values:"boolean"|"number"|"string"
- Default Value:boolean
- title String
The title used to describe the value returned by the expression.
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| ExpressionInfo | Creates a deep clone of the ExpressionInfo class. more details | more details | ExpressionInfo | |
| * | 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 | ExpressionInfo | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | ExpressionInfo |
Method Details
- clone(){ExpressionInfo}
Creates a deep clone of the ExpressionInfo class.
Returns:Type Description ExpressionInfo A deep clone of the ExpressionInfo instance.
- 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
jsonparameter 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.