Since version: 1.35
The imagery 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 displays, the script will execute using the pixel's variables and image metadata to compute the result. The app executing the expression will render the popup element as defined by the expression.
Unlike the Imagery Popup profile, this profile allows popup authors to return multiple values within a single element.
Context
The following products implement this profile:
Spatial reference
The spatial reference of the map in which the expression executes determines the execution context's spatial reference.
Time zone
The time zone of the map in which the expression executes determines the execution context's default time zone.
Profile variables
| Variable Name | Type | Description | Since version |
|---|---|---|---|
| $pixel | Pixel | The pixel value and other pixel-dependent information (e.g. classification category), including virtual raster fields, for the imagery layer currently displayed in the view. | 1.35 |
| $imageCollectionItem | Feature | The metadata of the image collection containing the pixel represented by $pixel. This value will be null if there is no associated image collection. | 1.35 |
| $userInput | Geometry | A geometry representing a user's input for a popup. Typically, this represents a location where the user clicked or tapped in a map to launch a popup. There may be cases where this value is a Point, an Extent, or null as popups are not always opened from map interaction. Therefore, it is advised to check the geometry type of this value before it is used. | 1.35 |
| $view | Dictionary | The properties available from the view, as defined in the table below. Only supported in 2D MapViews. | 1.35 |
Properties of $view:
| Variable Name | Type | Description |
|---|---|---|
| scale | Number | The scale of the map at the time the expression evaluates. |
| timeProperties.currentStart | Date | The start time of the map's time extent as indicated by a time slider component at the time the expression evaluates. This value dynamically updates (and may trigger the re-execution of the Arcade expression) when a time slider is used to update time-aware popups based on date field. A null value indicates the start time is inclusive since the beginning of time. |
| timeProperties.currentEnd | Date | The end time of the map's time extent as indicated by a time slider component at the time the expression evaluates. This value dynamically updates (and may trigger the re-execution of the Arcade expression) when a time slider is used to update time-aware popups based on date field. A null value indicates the end time is indefinite with no end. |
| timeProperties.startIncluded | Boolean | Indicates if the current date is included in the map's current time extent. |
| timeProperties.endIncluded | Boolean | Indicates if the current date is included in the map's current time extent. |
Function bundles
Return types
See the Web Map Specification for popupElement for a list of properties required for constructing a valid popup element dictionary.