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.15
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 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.

Note: The corresponding handler is onAttachmentChanged.


attachmentUrlChanged()

Emitted when the attachmentUrl property changes.

Note: The corresponding handler is onAttachmentUrlChanged.


contentTypeChanged()

Emitted when the contentType property changes.

Note: The corresponding handler is onContentTypeChanged.


editStateChanged()

Emitted when the editState property changes.

Note: The corresponding handler is onEditStateChanged.


fullImageStatusChanged()

Emitted when the fullImageStatus property changes.

Note: The corresponding handler is onFullImageStatusChanged.


fullImageUrlChanged()

Emitted when the fullImageUrl property changes.

Note: The corresponding handler is onFullImageUrlChanged.


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.

Note: The corresponding handler is onLoadErrorChanged.

See also Loadable and Object.


loadStatusChanged()

Emitted when the loadStatus property changes.

Note: The corresponding handler is onLoadStatusChanged.

See also Loadable.


localChanged()

Emitted when the local property changes.

Note: The corresponding handler is onLocalChanged.


nameChanged()

Emitted when the name property changes.

Note: The corresponding handler is onNameChanged.


popupTypeChanged()

Emitted when the popupType property changes.

Note: The corresponding handler is onPopupTypeChanged.


sizeAsIntChanged()

Emitted when the sizeAsInt property changes.

Note: The corresponding handler is onSizeAsIntChanged.

This signal was introduced in Esri.ArcGISRuntime 100.3.


sizeChanged()

Emitted when the size property changes.

Note: The corresponding handler is onSizeChanged.


thumbnailStatusChanged()

Emitted when the thumbnailStatus property changes.

Note: The corresponding handler is onThumbnailStatusChanged.


thumbnailUrlChanged()

Emitted when the thumbnailUrl property changes.

Note: The corresponding handler is onThumbnailUrlChanged.


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.


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

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close