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.
- See also:
// Creates an column chart where each category/value
// is an aggregate of two or more fields
layer.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
-
new ExpressionContent(properties)
-
Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | more details The name of the class. | more details | Accessor | |
ElementExpressionInfo | more details Contains the Arcade expression used to create a popup content element. | more details | ExpressionContent | |
String | more details The type of popup element displayed. | more details | ExpressionContent |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
expressionInfo ElementExpressionInfoautocast
-
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.
-
type Stringreadonly
-
The type of popup element displayed. This value is always
expression
.For ExpressionContent the type is always "expression".
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
ExpressionContent | more details Creates a deep clone of the ExpressionContent instance. | more details | ExpressionContent | |
* | more details Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | more details | ExpressionContent | |
more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor | ||
Object | more details Converts an instance of this class to its ArcGIS portal JSON representation. | more details | ExpressionContent |
Method Details
-
clone(){ExpressionContent}
-
Creates a deep clone of the ExpressionContent instance.
Returns:Type Description ExpressionContent A deep clone of the ExpressionContent 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 ObjectA 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)inheritedSince: 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.