Popup Element

Since version: 1.16

The popup element profile allows map authors to write expressions that return a dictionary representing either a rich text, fields table, or media (i.e. a chart or an image) popup element. The returned dictionary must follow the Web Map Specification for a popupElement. When the popup opens, the expression will execute using the feature's attributes as variables. The app executing the expression will render the popup element as defined by the expression.

Unlike the Popup profile, this profile allows popup authors to return multiple values within a single element.

Context

This profile was created for use in the following contexts:

• ArcGIS Maps SDK for JavaScript
• ArcGIS Pro
• ArcGIS Enterprise
• ArcGIS Online
• ArcGIS Maps SDKs for Native Apps

Profile variables

Function bundles

Core | Geometry | Data Access | Portal Access

Return types

Dictionary

See the Web Map Specification for popupElement for a list of properties required for constructing a valid popup element dictionary.

Example

Returns a HTML list that describes the number of power plants used to generate power for each fuel type in the cluster.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
Expects($aggregatedFeatures, "fuel1")

var statsFS = GroupBy($aggregatedFeatures,
  [
    { name: 'Type', expression: 'fuel1'},
  ],
  [  // statistics to return for each fuel type
    { name: 'num_features', expression: '1', statistic: 'COUNT' }
  ]
);
var ordered = OrderBy(statsFs, 'num_features DESC');

var list = "<ol>";

for (var group in ordered){
  list += `<li>${group.Type} (${Text(group.num_features, "#,###")})</li>`
}
list += "</ol>";

return {
  type: "text",
  text: list
}