ExpressionInfo | References | ArcGIS Maps SDK for JavaScript

import ExpressionInfo from "@arcgis/core/webdoc/geotriggersInfo/ExpressionInfo.js";

Inheritance:: ExpressionInfo→Accessor

Since: ArcGIS Maps SDK 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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`ExpressionInfoProperties`

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`expression`	`string \| null \| undefined`
`returnType`	`"number" \| "string"`
`title`	`string \| null \| undefined`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

expression

Property

Type: string | null | undefined

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

returnType

Property

Type: "number" | "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.

Default value: "string"

title

Property

Type: string | null | undefined

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

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone` inherited	`clone(): this`	ClonableMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

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

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.