PictureFillSymbol

Uses an image to fill the shape of graphic and feature polygons with a repeating pattern. Supported image formats are BMP, GIF, ICO, JPEG, and PNG. Animated GIF is not supported.

Since

200.1.0

See also

Constructors

Link copied to clipboard
constructor()

Creates a picture fill symbol object.

constructor(url: String)

Creates a picture fill symbol object from an image URL. Supported image formats are BMP, GIF, ICO, JPEG, and PNG. Animated GIF is not supported.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The rotation angle of the picture fill symbol in degrees. The angle will rotate the symbol about its center relative to north. A positive value rotates the symbol clockwise, a negative value rotates the symbol anti-clockwise. The default value is 0.0.

Link copied to clipboard

The height of the picture fill symbol in device-independent pixels (DIPs). The height of the symbol spanning from the bottom to the top of the image. The default value is 0.0. You can use this property to override the height of the symbol. Note that if you set the PictureFillSymbol.height or PictureFillSymbol.width to 0.0, then the picture fill symbol will adopt the height and width of the loaded PictureFillSymbol.image.

Link copied to clipboard

The image used for the picture fill symbol to fill the polygon geometries.

Link copied to clipboard

The horizontal offset of the picture fill symbol.

Link copied to clipboard

The vertical offset of the picture fill symbol.

Link copied to clipboard

The opacity for the picture fill symbol. The value ranges from 0.0 (fully transparent) to 1.0 (opaque). The default value is 1.0.

Link copied to clipboard

The horizontal scaling of the picture fill symbol. The default value is 1.0.

Link copied to clipboard

The vertical scaling of the picture fill symbol. The default value is 1.0.

Link copied to clipboard
val url: String?

The URL of the picture fill symbol. The URL is the address location of where the image is being stored. This address can come from an online source or from a locally stored location. In order to use a PictureFillSymbol from a URL, the symbol must be loaded asynchronously. Any properties that are changed while this symbol is loading will persist once the image has loaded.

Link copied to clipboard

The width of the picture fill symbol in device-independent pixels (DIPs). The width of the symbol spanning from the left to the right side of the image. The default value is 0.0. You can use this property to override the width of the symbol. Note that if you set the PictureFillSymbol.height or PictureFillSymbol.width to 0.0, then the picture fill symbol will adopt the height and width of the loaded PictureFillSymbol.image.

Inherited properties

Link copied to clipboard

The interior color of the fill symbol.

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

The load status.

Link copied to clipboard

A line, with a specific color and width, to be applied to the fill symbol.

Functions

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

Clones the PictureFillSymbol.

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Inherited functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

Link copied to clipboard
suspend fun createSwatch(screenScale: Float, width: Float? = null, height: Float? = null, backgroundColor: Color = Color.transparent): Result<BitmapDrawable>

Creates a swatch of the symbol. This method will scale the symbol up or down in order to fit it in to the desired width and height of the swatch.

suspend fun createSwatch(screenScale: Float, width: Float, height: Float, geometry: Geometry, backgroundColor: Color = Color.transparent): Result<BitmapDrawable>

Creates a swatch of the symbol.

Link copied to clipboard
open override fun hashCode(): Int
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.

Link copied to clipboard
open override fun toJson(): String

Convert an object to JSON string.