arcgis-maps-kotlin/com.arcgismaps.mapping.symbology/PictureFillSymbol

PictureFillSymbol

class PictureFillSymbol : FillSymbol, Loadable

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

Constructors

PictureFillSymbol

fun PictureFillSymbol()

Creates a picture fill symbol object.

PictureFillSymbol

fun PictureFillSymbol(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

Companion

object Companion

Properties

angle

var angle: Double

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.

height

var height: Float

The height of the picture fill symbol in device-independent pixels (DIPs). The height of the symbol spanning from the bottom to the top side of the image. When setting the height, if the width is set to 0.0 then no effect will take place. In this case the image to be displayed at its default size. The default value is 0.0.

image

val image: BitmapDrawable?

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

offsetX

var offsetX: Double

The horizontal offset of the picture fill symbol.

offsetY

var offsetY: Double

The vertical offset of the picture fill symbol.

opacity

var opacity: Float

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.

scaleX

var scaleX: Double

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

scaleY

var scaleY: Double

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

url

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.

width

var width: Float

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. When setting the width, if the height is set to 0.0 then no effect will take place. In this case the image to be displayed at its default size. The default value is 0.0.

Inherited properties

color

var color: Color

The interior color of the fill symbol.

loadStatus

open override val loadStatus: StateFlow<LoadStatus>

The load status.

outline

var outline: LineSymbol?

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

Functions

clone

open override fun clone(): PictureFillSymbol

Clones the PictureFillSymbol.

equals

open operator override fun equals(other: Any?): Boolean

toMultilayerSymbol

fun toMultilayerSymbol(): MultilayerPolygonSymbol

Converts a PictureFillSymbol to a MultilayerPolygonSymbol with a PictureFillSymbolLayer. The resulting MultilayerPolygonSymbol contains a single PictureFillSymbolLayer.

Inherited functions

cancelLoad

open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

createSwatch

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.

hashCode

open override fun hashCode(): Int

load