Properties that extend the ArcGis portal representation of a PopupContent.

interface ContentProperties {
    $ref?: ContentRef;
    attributes?: Record<string, unknown>;
    description?: string;
    displayCount?: number;
    displayType?: string;
    expressionInfo?: PopupExpressionInfoJson;
    fieldInfos?: FieldInfoJson[];
    mediaInfos?: MediaInfoJson[];
    orderByFields?: OrderByFieldsJson[];
    relationshipId?: number;
    text?: string;
    title?: string;
    type?:
        | "text"
        | "fields"
        | "expression"
        | "attachments"
        | "media"
        | "relationship";
}

Hierarchy (view full)

Properties

$ref?: ContentRef

A popupContent name referring to an existing popupContent in a featureSettings. The popupContent extension will attempt to find an existing popupContent in its parent featureSettings.

attributes?: Record<string, unknown>

A dictionary of key value pairs representing attributes to be used instead of fields and their values. This property is only used when the element is of type expression and should be returned as part of the arcade expression itself. This property allows passing arcade derived attribute values into fields or media elements.

description?: string

An optional string value describing the element in detail. This property does not apply when the type is text or expression.

displayCount?: number

This property applies to elements of type relationship. An integer that indicates the maximum number of records to display.

displayType?: string

This property applies to elements of type attachments and relationship. A string value indicating how to display the attachment. Possible values are, 'preview', and 'list' for attachments types, and 'list' for relationship types. If list is specified, attachments show as links.

expressionInfo?: PopupExpressionInfoJson

This property applies to elements of type expression. An Arcade expression that defines the pop-up element content.

fieldInfos?: FieldInfoJson[]

This property applies to elements of type fields. It is an array of popupInfo.fieldInfo objects representing a field/value pair displayed as a table within the popupElement. If the fieldInfos property is not provided, the popupElement will display whatever is specified directly in the popupInfo.fieldInfos property.

mediaInfos?: MediaInfoJson[]

This property applies to elements of type media. An array of popupInfo.mediaInfo objects representing an image or chart for display. If no mediaInfos property is provided, the popupElement will display whatever is specified in the popupInfo.mediaInfo property.

orderByFields?: OrderByFieldsJson[]

This property applies to elements of type relationship. Array of orderByFields objects indicating the field display order for the related records and whether they should be sorted in ascending 'asc' or descending 'desc' order.

relationshipId?: number

This property applies to elements of type relationship. The id of the relationship as defined in the feature layer definition.

text?: string

This property applies to elements of type text. This is string value indicating the text to be displayed within the popupElement. If no text property is provided, the popupElement will display whatever is specified in the popupInfo.description property.

title?: string

An optional string value indicating what the element represents. This property does not apply when the type is text or expression.

type?:
    | "text"
    | "fields"
    | "expression"
    | "attachments"
    | "media"
    | "relationship"

String value indicating which element to use.