PictureMarkerSymbolLayer QML Type

  • Esri.ArcGISRuntime
  • PictureMarkerSymbolLayer
  • Represents a symbol layer used to place a picture marker on a point geometry. More...

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

    MarkerSymbolLayer

    Properties

    Signals

    Methods

    Detailed Description

    This symbol layer, in a MultilayerPointSymbol, places a picture marker at the location of the point feature. The class supports changing dimensions of the marker, specifying the image (or url linking to the image) to use as the marker, as well as the general marker options provided by the MarkerSymbolLayer base class.

    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.

    Example:

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

    PictureMarkerSymbolLayer {
        id: pictureMarkerSymbolLayer
        url: "http://static.arcgis.com/images/Symbols/Basic/YellowStickpin.png"
    }

    See also 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 layer is loaded.


    [read-only] error : Error

    Returns the error object (read-only).

    See also Loadable and Error.


    [read-only] image : url

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

    If a URL was provided for the picture marker symbol layer, 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.


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


    [default] requestConfiguration : RequestConfiguration

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


    [since Esri.ArcGISRuntime 100.6] tintColor : color

    The tint color of the picture marker symbol layer.

    The tint color is applied to the entire image by multiplying each RGB color channel in the image by the corresponding color channel of the tint color. The default color is white with 100% opacity (RGBA (255,255,255,255)), which when applied leaves the image with its native colors and unchanged opacity. A white tint color with opacity less than 100% applies the reduced opacity without changing the image colors.

    When getting the tint color from a symbol, the consensus value is reported. If there is no consensus (one or more layers have different tint colors), a null value is reported for the tint color. Likewise, setting a value for tint color on a symbol will apply that tint color to all layers the symbol contains.

    This property was introduced in Esri.ArcGISRuntime 100.6.


    url : url

    The URL path to the picture marker symbol layer 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 layer is loaded.


    Signal Documentation

    credentialChanged()

    Emitted when the credential property changes.

    Note: The corresponding handler is onCredentialChanged.


    imageChanged()

    Emitted when the image property changes.

    Note: The corresponding handler is onImageChanged.


    loadErrorChanged()

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

    Note: The corresponding handler is onLoadStatusChanged.

    See also Loadable.


    requestConfigurationChanged()

    Emitted when the requestConfiguration property changes.

    Note: The corresponding handler is onRequestConfigurationChanged.


    [since Esri.ArcGISRuntime 100.6] tintColorChanged()

    Emitted when the tintColor property changes.

    Note: The corresponding handler is onTintColorChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.6.


    urlChanged()

    Emitted when the url property changes.

    Note: The corresponding handler is onUrlChanged.


    Method Documentation

    void cancelLoad()

    See also Loadable.


    void load()

    See also Loadable.


    void retryLoad()

    See also Loadable.


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