PopupAttachment QML Type

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

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

    Object

    Properties

    Signals

    Methods

    Detailed Description

    Obtain PopupAttachments from the PopupAttachmentManager.

    See also Loadable.

    Property Documentation

    [read-only] attachment : Attachment

    Returns the underlying attachment (read-only).


    [read-only] contentType : string

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


    [read-only] editState : Enums.PopupAttachmentEditState

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

    See also Enums.PopupAttachmentEditState.


    [read-only, since Esri.ArcGISRuntime 200.2] filePath : url

    Returns the local temporary filepath where we store the attachment once it is loaded (read-only).

    This property was introduced in Esri.ArcGISRuntime 200.2.


    [read-only] fullImageStatus : Enums.TaskStatus

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

    See also Enums.TaskStatus.


    [read-only] 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.


    [read-only] 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.


    [read-only] loadStatus : Enums.LoadStatus

    The Enums.LoadStatus of the Layer.

    See also Loadable and Enums.LoadStatus.


    [read-only] local : bool

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


    [read-only] name : string

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


    [read-only] popupType : Enums.PopupAttachmentType

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

    See also Enums.PopupAttachmentType.


    [read-only] size : string

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

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

    See also sizeAsInt.


    [read-only, since Esri.ArcGISRuntime 100.3] sizeAsInt : int

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

    Note: The underlying 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.


    [read-only] thumbnailStatus : Enums.TaskStatus

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

    See also Enums.TaskStatus.


    [read-only] 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.


    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.


    [since Esri.ArcGISRuntime 200.2] filePathChanged()

    Emitted when the filePath property changes.

    Note: The corresponding handler is onFilePathChanged.

    This signal was introduced in Esri.ArcGISRuntime 200.2.


    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.


    [since Esri.ArcGISRuntime 100.3] 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.