import ExpressionContent from "@arcgis/core/popup/content/ExpressionContent.js";const ExpressionContent = await $arcgis.import("@arcgis/core/popup/content/ExpressionContent.js");- Since
- ArcGIS Maps SDK for JavaScript 4.22
An ExpressionContent element allows you to define a popup content element with an Arcade expression. The expression must evaluate to a dictionary representing a TextContent, FieldsContent, or a MediaContent popup element as defined in the Popup Element web map specification.
Expressions defining popup content typically use the attributes property of an element to reference
values calculated within the expression in a table or a chart.
This content element is designed for advanced scenarios where content in charts, tables, or rich text elements is based on logical conditions. For example, if data in one or more fields is empty, you can use this element to dynamically create a table consisting only of fields containing valid data values. You can also use this element to create charts or other content types consisting of aggregated data values. This can be especially useful in cluster popups.
Example
// Creates an column chart where each category/value// is an aggregate of two or more fieldslayer.popupTemplate = { title: "Educational Attainment", content: [{ type: "expression", expressionInfo: { expression: ` // Create a dictionary of attributes representing the values // to display in the chart var attributes = { "No School": $feature.no_school + $feature.some_primary, "Primary": $feature.primary_complete + $feature.some_secondary, "Secondary": $feature.secondary_complete + $feature.some_highSchool, "High School": $feature.highSchool_diploma + $feature.highSchool_ged + $feature.some_college, "College/University": $feature.associates + $feature.bachelors + $feature.masters + $feature.doctorate + $feature.professional; };
var fields = [];
// Create an array representing the attribute names (or keys) for (var k in attributes){ Push(fields, k); }
// Returns a dictionary providing the information // required by the popup to render a column chart return { type: "media", attributes: attributes, title: "Educational attainment", mediaInfos: [{ type: "columnchart", value: { // The list of attribute names (keys) to include in the chart fields: fields } }] }; `, title: "Educational Attainment" } }]};Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
declaredClass readonly inherited | ||
| | ||
type readonly | "expression" | |
expressionInfo
Contains the Arcade expression used to create a popup content element. See the ElementExpressionInfo documentation for details and examples for how to create these expressions.
Methods
fromJSON
- Signature
-
fromJSON (json: any): any
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 | 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
- Signature
-
clone (): ExpressionContent
Creates a deep clone of the ExpressionContent instance.
- Returns
- ExpressionContent
A deep clone of the ExpressionContent instance.
toJSON
- Signature
-
toJSON (): any
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.