A symbol layer that fills polygon geometry with an image. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.5 |
| Inherits: |
Properties
- credential : Credential
- error : Error
- image : url
- loadError : Error
- loadStatus : Enums.LoadStatus
- requestConfiguration : RequestConfiguration
- tintColor : color
- url : url
Signals
- credentialChanged()
- imageChanged()
- loadErrorChanged()
- loadStatusChanged()
- requestConfigurationChanged()
- tintColorChanged()
- urlChanged()
Methods
- void cancelLoad()
- void load()
- void retryLoad()
Detailed Description
The specified image fills the layer's polygon if it is the only symbol layer in a MultilayerPolygonSymbol. If a single image does not completely fill the geometry, it is tiled to complete the fill.
This layer can also represent the Web Scene specification's Icon3DSymbolLayers. PictureFillSymbolLayer represents IconSymbol3DLayers that contain pictures and VectorMarkerSymbolLayer represents Icon3DSymbolLayers that are primitives or vector paths.
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 fill symbol is loaded.
Returns the picture fill symbol image once loaded (read-only).
If a URL was provided for the picture fill 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.
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.
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.
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 colors), a null value is reported for the 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.
The URL path to the picture fill 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 fill symbol is loaded.
Signal Documentation
Emitted when the credential property changes.
Note: The corresponding handler is onCredentialChanged.
Emitted when the image property changes.
Note: The corresponding handler is onImageChanged.
Emitted when the loadError property of this PictureFillSymbolLayer changes.
Note: load errors are also reported on the error property and emit the errorChanged signal.
Note: The corresponding handler is onLoadErrorChanged.
Emitted when the loadStatus property of this PictureFillSymbolLayer changes.
Note: The corresponding handler is onLoadStatusChanged.
See also Loadable.
Emitted when the requestConfiguration property changes.
Note: The corresponding handler is onRequestConfigurationChanged.
Emitted when the tintColor property changes.
Note: The corresponding handler is onTintColorChanged.
This signal was introduced in Esri.ArcGISRuntime 100.6.
Emitted when the url property changes.
Note: The corresponding handler is onUrlChanged.
Method Documentation
See also Loadable.
See also Loadable.
See also Loadable.