PictureMarkerSymbol QML Type

  • Esri.ArcGISRuntime
  • PictureMarkerSymbol
  • Uses an image to symbolize GeoElements that have Point or Multipoint. More...

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

    MarkerSymbol

    Properties

    Signals

    Methods

    Detailed Description

    Instances of this type represent picture marker symbols. Picture marker symbols display graphics using a picture image. Symbols describe how graphics and features look on a map. Different symbols are used with different geometry types. Marker symbols are used to display those graphics and features that are based on point or multipoint geometries. Supported image formats are BMP, GIF, ICO, JPEG, and PNG. Animated GIF is not supported.

    This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.

    TypeDefault Property
    Credentialcredential
    RequestConfigurationrequestConfiguration (since Esri.ArcGISRuntime 100.1)

    Example:

    Create a PictureMarkerSymbol and set its URL to an online PNG:

    PictureMarkerSymbol {
        id: pictureMarkerSymbol
        url: "http://static.arcgis.com/images/Symbols/Basic/YellowStickpin.png"
        width: 15
        height: 15
    }

    See also JsonSerializable, Loadable, and RemoteResource.

    Property Documentation

    [default] credential : Credential

    The credential to be used to access a secured image URL if provided.

    A credential can only be provided before the picture marker symbol is loaded.


    [read-only] error : Error

    Returns the error object (read-only).

    See also Loadable and Error.


    height : real

    The height of the symbol in device independent pixels (DIPs).

    Defaults to size of the image.


    [read-only] image : url

    Returns the picture marker symbol image once loaded (read-only).

    If a URL was provided for the picture marker symbol, an attempt to load the symbol must occur and succeed, and then the image provider source is available via this property. Prior to loading in this case, this will return an empty url. Supported image formats are BMP, GIF, ICO, JPEG, and PNG. Animated GIF is not supported.


    [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

    Returns the load status (read-only).

    See also Loadable and Enums.LoadStatus.


    opacity : real

    The opacity of the symbol.

    Defaults to 1.0 (fully opaque). Permitted values range between 0-1.


    [default, since Esri.ArcGISRuntime 100.1] requestConfiguration : RequestConfiguration

    The configuration parameters used for network requests sent by this symbol.

    This property was introduced in Esri.ArcGISRuntime 100.1.


    url : url

    The URL path to the picture marker symbol image.

    This could be a local file path, Qt resource path, or HTTP path to the image. The URL can only be provided before the picture marker symbol is loaded. Supported image formats are BMP, GIF, ICO, JPEG, and PNG. Animated GIF is not supported.


    width : real

    The width of the symbol in device independent pixels (DIPs).

    Defaults to size of the image.


    Signal Documentation

    credentialChanged()

    Emitted when the credential property changes.

    Note: The corresponding handler is onCredentialChanged.


    heightChanged()

    Emitted when the height property changes.

    Note: The corresponding handler is onHeightChanged.


    imageChanged()

    Emitted when the image property changes.

    Note: The corresponding handler is onImageChanged.


    loadErrorChanged()

    Emitted when the loadError property of this PictureMarkerSymbol 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 of this PictureMarkerSymbol changes.

    Note: The corresponding handler is onLoadStatusChanged.

    See also Loadable.


    opacityChanged()

    Emitted when the opacity property changes.

    Note: The corresponding handler is onOpacityChanged.


    [since Esri.ArcGISRuntime 100.1] requestConfigurationChanged()

    Emitted when the requestConfiguration property changes.

    Note: The corresponding handler is onRequestConfigurationChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.1.


    urlChanged()

    Emitted when the url property changes.

    Note: The corresponding handler is onUrlChanged.


    widthChanged()

    Emitted when the width property changes.

    Note: The corresponding handler is onWidthChanged.


    Method Documentation

    void cancelLoad()

    See also Loadable.


    [since Esri.ArcGISRuntime 200.1] bool equals(PictureMarkerSymbol other)

    Compares two PictureMarkerSymbols for equality.

    Returns whether this instance and other are equivalent.

    This method was introduced in Esri.ArcGISRuntime 200.1.


    void load()

    See also Loadable.


    void retryLoad()

    See also Loadable.


    [since Esri.ArcGISRuntime 100.13] MultilayerPointSymbol toMultilayerSymbol()

    Get a multilayer point symbol generated from picture marker symbol.

    Given a picture marker symbol, this method will return a MultilayerPointSymbol with a PictureMarkerSymbolLayer.

    This method was introduced in Esri.ArcGISRuntime 100.13.


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