ESM: import ExpressionInfo from "@arcgis/core/form/ExpressionInfo.js";
CDN: const ExpressionInfo = await $arcgis.import("@arcgis/core/form/ExpressionInfo.js");
Class: @arcgis/core/form/ExpressionInfo
Since: ArcGIS Maps SDK for JavaScript 4.16
The ExpressionInfo
class defines the makeup of visibility expressions, required expressions, editable expressions, and value expressions. Visibility expressions are available on field, group, and relationship elements. These elements are contained within a formTemplate
set directly on either a FeatureForm or FeatureLayer.
All of the Arcade expressions referenced above, excluding value expressions, must follow the specification defined in the Form Constraint Profile. This profile may reference field values using the $feature
variable and the expression must return true
or false
.
Value expressions must follow the specification defined in the Form Calculation Profile. It may reference field values within an individual $feature
or in other layers and must return either a date, number, or string value. Once the expression evaluates, the form's field value updates to the expressions' result.
It is required to set the map property when instantiating a FeatureForm widget and using expressions that use the $map
variable.
new ExpressionInfo(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
.
expression String
Example
// Sets the visibility of a field in the form template only if the date is within the last 24 hours.
expressionInfo.expression = "IIF(DateDiff(Now(), $feature.incident_date, 'hours') < 24)";
returnType String
Indicates the return type of the Arcade expression. In FeatureForm expressions, the returnType can be boolean
, date
, number
or string
. This is dependant upon the type of expression used. For example, visibility expressions, required expressions, and editable expressions only return a boolean, whereas value expressions return either date
, number
, or string
.
Possible Values:"boolean" |"date" |"number" |"string"
The title used to describe the value returned by the expression.
Example
expressionInfo.title = "Did the incident occur within the last 24 hours?";
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 deep clone of the ExpressionInfo class.
Returns
Type Description ExpressionInfo A deep clone of the ExpressionInfo instance.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