PictureFillSymbol QML Type

GeoElement."> PictureFillSymbol QML Type | ArcGISQtQml
  • Esri.ArcGISRuntime
  • PictureFillSymbol
  • Uses an image to symbolize the fill for a Polygon GeoElement. More...

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

    FillSymbol

    Properties

    Signals

    Methods

    Detailed Description

    Supported image formats are BMP, GIF, ICO, JPEG, and PNG. Animated GIF is not supported. Symbols describe how graphics and features look on a map. Different symbols are used with different geometry types. Instances of this class represent picture fill symbols. Fill symbols are used with graphics and features that are based on Polygon geometries. The symbol defines how to fill the interior of a polygon using pictures.

    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 PictureFillSymbol and set its URL to an online PNG:

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

    See also Symbol, JsonSerializable, Loadable, and RemoteResource.

    Property Documentation

    angle : real

    The angle of the picture fill symbol in degrees (from 0 to 360).

    Defaults to 0.0. The rotation is clockwise.


    [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 fill 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 the size of the image.


    [read-only] image : url

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

    Supported image formats are BMP, GIF, ICO, JPEG, and PNG. Animated GIF is not supported.

    If a URL was provided for the picture fill symbol, an attempt to load the symbol must occur and succeed, before the image source will be 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.


    opacity : real

    The opacity of the symbol.

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


    [default] requestConfiguration : RequestConfiguration

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


    scaleX : real

    The x scale of the picture fill symbol.

    Defaults to 1.0.


    scaleY : real

    The y scale of the picture fill symbol.

    Defaults to 1.0.


    url : url

    The URL path to the picture fill symbol image.

    Supported image formats are BMP, GIF, ICO, JPEG, and PNG. Animated GIF is not supported.

    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 fill symbol is loaded.


    width : real

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

    Defaults to the size of the image.


    Signal Documentation

    angleChanged()

    Emitted when the angle property changes.

    Note: The corresponding handler is onAngleChanged.


    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 PictureFillSymbol 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 PictureFillSymbol changes.

    Note: The corresponding handler is onLoadStatusChanged.

    See also Loadable.


    opacityChanged()

    Emitted when the opacity property changes.

    Note: The corresponding handler is onOpacityChanged.


    requestConfigurationChanged()

    Emitted when the requestConfiguration property changes.

    Note: The corresponding handler is onRequestConfigurationChanged.


    scaleXChanged()

    Emitted when the scaleX property changes.

    Note: The corresponding handler is onScaleXChanged.


    scaleYChanged()

    Emitted when the scaleY property changes.

    Note: The corresponding handler is onScaleYChanged.


    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(PictureFillSymbol other)

    Compares two PictureFillSymbols 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] MultilayerPolygonSymbol toMultilayerSymbol()

    Get a multilayer polygon symbol, generated from picture fill symbol.

    Given a picture fill symbol, this method will return a MultilayerPolygonSymbol with a PictureFillSymbolLayer.

    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.