Options
All
  • Public
  • Public/Protected
  • All
Menu

Defines the look and feel of pop-up windows when users click or query a feature.

Part of the Esri web map specification. See http://resources.arcgis.com/en/help/arcgis-web-map-json/.

Hierarchy

  • PopupInfo

Index

Properties

Optional description

description: string

A string that appears in the body of the pop-up window as a description. This can contain a field or expression name enclosed in {},such as {DETAILS}.

Optional expressionInfos

expressionInfos: ExpressionInfo[]

List of Arcade expressions added to the pop-up.

Optional fieldInfos

fieldInfos: FieldInfo[]

An array of {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.webMap.FieldInfo} objects defining how each field in the dataset participates (or does not participate) in the pop-up window. The order of the array is the order that fields are shown in the pop-up window.

Optional layerOptions

layerOptions: any

Additional options that can be defined for the popup layer.

Optional mediaInfos

mediaInfos: MediaInfo[]

An array of {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.webMap.MediaInfo} objects that define images and charts displayed in the pop-up window.

Optional popupElements

popupElements: object[]

An array of popupElement objects that represent an ordered list of popup elements. See https://developers.arcgis.com/web-map-specification/objects/popupElement/

Optional relatedRecordsInfo

relatedRecordsInfo: object

Indicates whether to enable related records if they exist on a layer. See https://developers.arcgis.com/web-map-specification/objects/relatedRecordsInfo/

Type declaration

  • Optional orderByFields?: object[]
  • Optional showRelatedRecords?: boolean

Optional showAttachments

showAttachments: boolean

A Boolean property determining whether attachments will be loaded for feature layers that have attachments.

Optional showLastEditInfo

showLastEditInfo: boolean

Indicates whether popup will display information about when and who last edited the feature. Applicable only to layers that have been configured to keep track of such information.

Optional title

title: string

A string that appears at the top of the pop-up window as a title. This can contain a field or expression name enclosed in {}, such as {NAME}.