ExpressionInfo

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

The ExpressionInfo class references Arcade expressions following the specification defined by the Arcade Popup Profile. Expressions must return a string or a number and may access data values from the feature, its layer, or other layers in the map or datastore with the $feature, $layer, $map, and $datastore global variables.

Expression names are referenced in a layer's PopupTemplate and execute once a layer's popup is opened. The values display within the view's popup as if they are field values. They can be displayed in a table using the FieldInfo of the popupTemplate's content or referenced within a simple string.

See also:
Example:
// Display a table in the popup's content referencing two values
// one from a field, and another returned from an Arcade expression
layer.popupTemplate = {
  title: "Population in {NAME}",
  content: [{
    type: "fields",
    fieldInfos: [{
      fieldName: "POP_2015",
      label: "Total population (2015)",
      format: {
        digitSeparator: true
      }
    }, {
      fieldName: "expression/per-asian"
    }]
  }]
};

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 Arcade Popup Profile.

more detailsExpressionInfo
Stringmore details

The name of the expression.

more detailsExpressionInfo
String|Numbermore details

Indicates the return type of the Arcade expression.

more detailsExpressionInfo
Stringmore details

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

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 Arcade Popup Profile. Expressions must return a string or a number and may access data values from the feature, its layer, or other layers in the map or datastore with the $feature, $layer, $map, and $datastore global variables.

See also:
Example:
// Calculates the percentage of the population that is Asian
expressionInfo.expression = "Text($feature.Asian / $feature.TOT_POP, '#.#%')";
name String

The name of the expression. This is used to reference the value of the given expression in the popupTemplate's content property by wrapping it in curly braces and prefacing it with expression/ (e.g. {expression/expressionName}).

Example:
expressionInfo.name = "percent-asian";
returnType String|Number

Indicates the return type of the Arcade expression.

title String

The title used to describe the value returned by the expression in the popup. This will display if the value is referenced in a FieldInfo table.

Example:
expressionInfo.title = "Percent Asian";

Method Overview

Show inherited methods Hide inherited methods
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
more details

Adds one or more handles which are to be tied to the lifecycle of the object.

more detailsAccessor
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.
own(handleOrHandles)inherited
Since: ArcGIS API for JavaScript 4.24

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.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
});

handle.remove();

// Assign a handle using own()
this.own(reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
  }));
Parameter:
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

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.