ExpressionInfo

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

Defines a script expression that can be used to compute values. The script may refer to external data which will be available when the expression is being evaluated.

Example:
let expression = new ExpressionInfo({
  title: "Notice",
  expression: "'You have entered' + $fencefeature.AREA_NAME"
})

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

Optional expression in the Arcade expression language.

more detailsExpressionInfo
Stringmore details

Optional return type of the Arcade expression.

more detailsExpressionInfo
Stringmore details

Optional title of 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

Optional expression in the Arcade expression language. If no expression is provided, then the default empty expression produces a null, empty string, zero or false when evaluated (depending on usage and context).

Default Value:null
returnType String

Optional return type of the Arcade expression. Number values are assumed to be double. This can be determined by the authoring client by executing the expression using a sample feature, although it can be corrected by the user. Knowing the returnType allows the authoring client to present fields in relevant contexts. For example, numeric fields in numeric contexts such as charts.

Possible Values:"number"|"string"

Default Value:string
title String

Optional title of the expression. Typically used when presenting the expression to end-users e.g. in dialogs, table-of-contents or editing tools.

Default Value:null

Method Overview

Name Return Type Summary Class
thismore details

Creates a deep clone of this object.

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(){this}

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns:
Type Description
this A deep clone of the class instance that invoked this method.
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.