arcgis-maps-kotlin/com.arcgismaps.mapping.popup/AttachmentsPopupElement

AttachmentsPopupElement

class AttachmentsPopupElement : PopupElement

Represents a pop-up element of type attachments that is displayed in a pop-up for a geoelement.

Since

200.1.0

See also

PopupElementType

Constructors

Link copied to clipboard
constructor(displayType: PopupAttachmentsDisplayType = PopupAttachmentsDisplayType.Auto)

Creates a new attachments pop-up element with the given PopupAttachmentsDisplayType.

Properties

Link copied to clipboard
val attachments: List<PopupAttachment>

Returns all the current attachments. Will be empty if attachments haven't yet been fetched or if PopupElement.isEvaluated is false.

Link copied to clipboard
var description: String

A string value describing the element in detail. Can be an empty string.

Link copied to clipboard
var displayType: PopupAttachmentsDisplayType

Indicates how to display the attachments. If list is specified, attachments show as links. If preview is specified, attachments expand to the width of the pop-up. Setting the value to auto allows applications to choose the most suitable default experience for their application.

Link copied to clipboard
var title: String

A string value indicating what the element represents. Can be an empty string.

Inherited properties

Link copied to clipboard
val isEvaluated: Boolean

A value indicating whether the popup element is contained in the Popup.evaluatedElements.

Functions

Link copied to clipboard
suspend fun fetchAttachments(): Result<Unit>

Fetches the Attachments from the Feature, creates PopupAttachments from them, and populates AttachmentsPopupElement.attachments. Attachments are not re-fetched if they have already been fetched. If PopupElement.isEvaluated is false, this method will have no effect.

Inherited functions

Link copied to clipboard
open override fun toJson(): String

Convert an object to JSON string.