IPopupInfo

Interface

Defines the look and feel of popup windows when a user clicks or queries a feature.

Properties

PropertyTypeNotes
string

A string that appears in the body of the popup window as a description. It is also possible to specify the description as HTML-formatted content.

List of Arcade expressions added to the pop-up.

Array of fieldInfo information properties. This information is provided by the service layer definition. When the description uses name/value pairs, the order of the array is how the fields display in the editable Map Viewer popup and the resulting popup. It is also possible to specify HTML-formatted content.

{ showNoDataRecords: boolean }

Additional options that can be defined for the popup layer.

Array of various mediaInfo to display. Can be of type image, piechart, barchart, columnchart, or linechart. The order given is the order in which is displays.

An array of popupElement objects that represent an ordered list of popup elements.

Indicates whether to enable related records if they exist on a layer.

boolean

Indicates whether attachments will be loaded for feature layers that have attachments.

string

A string that appears at the top of the popup window as a title.

description

optional
Interface Property
description: string

A string that appears in the body of the popup window as a description. It is also possible to specify the description as HTML-formatted content.

expressionInfos

optional
Interface Property
expressionInfos: IPopupExpressionInfo[]

List of Arcade expressions added to the pop-up.

fieldInfos

optional
Interface Property
fieldInfos: IFieldInfo[]

Array of fieldInfo information properties. This information is provided by the service layer definition. When the description uses name/value pairs, the order of the array is how the fields display in the editable Map Viewer popup and the resulting popup. It is also possible to specify HTML-formatted content.

layerOptions

optional
Interface Property
layerOptions: { showNoDataRecords: boolean }

Additional options that can be defined for the popup layer.

Type declaration

    mediaInfos

    optional
    Interface Property
    mediaInfos: IMediaInfo[]

    Array of various mediaInfo to display. Can be of type image, piechart, barchart, columnchart, or linechart. The order given is the order in which is displays.

    popupElements

    optional
    Interface Property
    popupElements: IPopupElement[]

    An array of popupElement objects that represent an ordered list of popup elements.

    relatedRecordsInfo

    optional
    Interface Property
    relatedRecordsInfo: IRelatedRecordsInfo

    Indicates whether to enable related records if they exist on a layer.

    showAttachments

    optional
    Interface Property
    showAttachments: boolean

    Indicates whether attachments will be loaded for feature layers that have attachments.

    title

    optional
    Interface Property
    title: string

    A string that appears at the top of the popup window as a title.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.