• esri/form

ExpressionInfo

AMD: require(["esri/form/ExpressionInfo"], (ExpressionInfo) => { /* code goes here */ });
ESM: import ExpressionInfo from "@arcgis/core/form/ExpressionInfo";
Class: esri/form/ExpressionInfo
Inheritance: ExpressionInfo Accessor
Since: ArcGIS API for JavaScript 4.16

The ExpressionInfo class defines visibility expressions used to control FieldElement and GroupElement visibility within a FormTemplate.

The Arcade expression must follow the specification defined by the Constraint Profile. Expressions may reference field values using the $feature global variable and must return either true or false.

See also:

Constructors

new ExpressionInfo(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

An Arcade expression following the specification defined by the Constraint Profile.

more detailsExpressionInfo
Stringmore details

The name of the expression.

more detailsExpressionInfo
Stringmore details

Indicates the return type of the Arcade expression.

more detailsExpressionInfo
Stringmore details

The title used to describe the value returned by the expression.

more detailsExpressionInfo

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

expression String

An Arcade expression following the specification defined by the Constraint Profile. Expressions may reference field values using the $feature global variable and must return either true or false. If an expression returns true, then the field or group element will display in the FormTemplate. If false, then the field or group element will be hidden to the end user.

See also:
Example:
// Display 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)";
name String

The name of the expression. Set this name to the visibilityExpression property of the element to conditionally set its visibility.

Example:
expressionInfo.name = "withinRange";
returnType String

Indicates the return type of the Arcade expression. In FeatureForm expressions, the returnType can be boolean, date, number or string.

Possible Values:"boolean"|"date"|"number"|"string"

title String

The title used to describe the value returned by the expression.

Example:
expressionInfo.title = "Did the incident occur within the last 24 hours?";

Method Overview

Name Return Type Summary Class
ExpressionInfomore details

Creates a deep clone of the ExpressionInfo class.

more detailsExpressionInfo
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsExpressionInfo
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsExpressionInfo

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 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.

Parameter:
json Object

A 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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.