Skip To Content ArcGIS for Developers Sign In Dashboard

PopupAttachment QML Type

An attachment to a Popup, which contains the attachment data and some additional metadata about the attachment. More...

Import Statement: import Esri.ArcGISRuntime 100.6
Since: Esri.ArcGISRuntime 100.0
Inherits:

Object

Properties

Signals

Methods

Detailed Description

Obtain PopupAttachments from the PopupAttachmentManager.

See also Loadable.

Property Documentation

attachment : Attachment

Returns the underlying attachment (read-only).


attachmentUrl : url

Returns the PopupAttachment URL (read-only).


contentType : string

Returns the content type of the PopupAttachment (read-only).


editState : Enums.PopupAttachmentEditState

Returns the edit state of the PopupAttachment (read-only).

See also Enums.PopupAttachmentEditState.


fullImageStatus : Enums.TaskStatus

Returns the status of the asynchronous fullImage() operation (read-only).

See also Enums.TaskStatus.


fullImageUrl : url

Returns the URL to the full image (read-only).

Note: This property can be obtained after the fullImage() operation is executed, and the fullImageStatus is Enums.TaskStatusCompleted.


loadError : Error

Returns the load error (read-only).

Note: load errors are also reported on the error property and emit the errorChanged signal.

See also Loadable.


loadStatus : Enums.LoadStatus

The Enums.LoadStatus of the Layer.

See also Loadable and Enums.LoadStatus.


local : bool

Returns whether the PopupAttachment is local (read-only).


name : string

Returns the name of the PopupAttachment (read-only).


popupType : Enums.PopupAttachmentType

Returns the type of the PopupAttachment (read-only).

See also Enums.PopupAttachmentType.


size : string

Returns the size of the PopupAttachment in bytes (read-only).

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

See also sizeAsInt.


sizeAsInt : int

The same as size but represented as an integer type (read-only).

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

This QML property was introduced in Esri.ArcGISRuntime 100.3.


thumbnailStatus : Enums.TaskStatus

Returns the status of the asynchronous thumbnail() operation (read-only).

See also Enums.TaskStatus.


thumbnailUrl : url

Returns the URL to the thumbnail image (read-only).

Note: This property can be obtained after the thumbnail() operation is executed, and the thumbnailStatus is Enums.TaskStatusCompleted.


Signal Documentation

attachmentChanged()

Emitted when the attachment property changes.


attachmentUrlChanged()

Emitted when the attachmentUrl property changes.


contentTypeChanged()

Emitted when the contentType property changes.


editStateChanged()

Emitted when the editState property changes.


fullImageStatusChanged()

Emitted when the fullImageStatus property changes.


fullImageUrlChanged()

Emitted when the fullImageUrl property changes.


loadErrorChanged()

Emitted when the loadError property of this Layer changes.

Note: load errors are also reported on the error property and emit the errorChanged signal.

See also Loadable and Object.


loadStatusChanged()

Emitted when the loadStatus property changes.

See also Loadable.


localChanged()

Emitted when the local property changes.


nameChanged()

Emitted when the name property changes.


popupTypeChanged()

Emitted when the popupType property changes.


sizeAsIntChanged()

Emitted when the sizeAsInt property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.3.


sizeChanged()

Emitted when the size property changes.


thumbnailStatusChanged()

Emitted when the thumbnailStatus property changes.


thumbnailUrlChanged()

Emitted when the thumbnailUrl property changes.


Method Documentation

void cancelLoad()

See also Loadable.


void fullImage()

Returns the full image for displaying the attachment in full screen or some UI larger than a thumbnail.

This is only supported if the PopupAttachmentType is Image.

The fullImageStatusChanged signal will emit with a fullImageStatus of Enums.TaskStatusCompleted once complete.


void load()

See also Loadable.


void retryLoad()

See also Loadable.


void thumbnail(int width, int height, Enums::AspectRatioMode aspectRatioMode)

Returns a thumbnail image with a given width, height, and aspectRatioMode.

This is only supported if the PopupAttachmentType is Image.

The thumbnailStatusChanged signal will emit with a thumbnailStatus of Enums.TaskStatusCompleted once complete.



Feedback on this topic?