PictureFillSymbol

class PictureFillSymbol : FillSymbol, Loadable

Uses an image to symbolize the fill for a polygon geoelement. Supported image formats are BMP, GIF, ICO, JPEG, and PNG. Animated GIF is not supported.

See also

Constructors

Link copied to clipboard
fun PictureFillSymbol()

Creates a picture fill symbol object.

Link copied to clipboard
fun PictureFillSymbol(image: BitmapDrawable)

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

Link copied to clipboard
fun PictureFillSymbol(url: String)

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

Functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

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

Clones the PictureFillSymbol.

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 operator override fun equals(other: Any?): Boolean
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.

Link copied to clipboard
fun toMultilayerSymbol(): MultilayerPolygonSymbol

Get Multilayer polygon symbol generated from picture fill symbol. Given a picture fill symbol, this method will return a MultilayerPolygonSymbol with a PictureFillSymbolLayer.

Properties

Link copied to clipboard
var angle: Double

The angle of the picture fill symbol.

Link copied to clipboard
var color: Color

The color for the fill symbol.

Link copied to clipboard
var height: Float

The height of the picture fill symbol.

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

The load status.

Link copied to clipboard
var offsetX: Double

The x offset of the picture fill symbol.

Link copied to clipboard
var offsetY: Double

The y offset of the picture fill symbol.

Link copied to clipboard
var opacity: Float

The opacity for the symbol.

Link copied to clipboard
var outline: LineSymbol?
Link copied to clipboard
var scaleX: Double

The x scale of the picture fill symbol.

Link copied to clipboard
var scaleY: Double

The y scale of the picture fill symbol.

Link copied to clipboard
open override val unknownJson: Map<String, Any>

Unknown data from the source JSON. Unknown JSON is a dictionary of values that was in the source JSON but was unparsed by this API.

Link copied to clipboard
open override val unsupportedJson: Map<String, Any>

Unsupported data from the source JSON. Unsupported JSON is a dictionary of values that are supported by web maps, but not exposed through this API.

Link copied to clipboard
val url: String

The URL of the picture fill symbol.

Link copied to clipboard
var width: Float

The width of the picture fill symbol.