PictureFillSymbolLayer

A symbol layer that fills polygon geometry with an image. The specified image fills the layer's polygon if it's the only symbol layer in a MultilayerPolygonSymbol. If a single image doesn't 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.

Since

200.1.0

Constructors

Link copied to clipboard
constructor(uri: String)

Creates a picture fill symbol layer from a URI. Create a PictureFillSymbolLayer with an image URI. The given URI is used to retrieve the image data to use as the picture. The URI may be a URL or a file location.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The image held by a picture fill symbol layer. The BitmapDrawable held by the given PictureFillSymbolLayer. Setting the image visually changes the image that makes up the fill pattern. If the image is valid and non-empty, this function sets the image and sets the symbol layer's load status to LoadStatus.Loaded. You cannot set an image on a PictureFillSymbolLayer that has already loaded.

Link copied to clipboard

The tint color of a picture fill 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 tint color is white with 100% opacity, i.e. RGBA(255, 255, 255, 255), which leaves the image with its native colors. A white tint color with opacity less than 100% tints the image white, with the reduced opacity respected.

Link copied to clipboard
val uri: String?

The URI of a picture fill symbol layer. The URI of the PictureFillSymbolLayer. If there is no URI set, the method returns an empty string.

Inherited properties

Link copied to clipboard

The symbol layer color locked property. The color-locked status of the symbol layer. If color_locked is true, the color of that layer will not change.

Link copied to clipboard

The symbol layer enabled property. The enable status of the symbol layer. Layer will be rendered only if it is enabled.

Link copied to clipboard
open override val loadStatus: StateFlow<LoadStatus>

The load status.

Functions

Link copied to clipboard
open override fun clone(): PictureFillSymbolLayer

Inherited functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

Link copied to clipboard
open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

Link copied to clipboard
open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.