PictureMarkerSymbol

Uses an image to symbolize graphics and features that have point or multipoint geometry. 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 marker symbol.

constructor(url: String)

Creates a picture marker symbol 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 height of the picture marker 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 PictureMarkerSymbol.height or PictureMarkerSymbol.width to 0.0, then the picture fill symbol will adopt the height and width of the loaded PictureMarkerSymbol.image.

Link copied to clipboard

The image used to visualize this picture marker symbol.

Link copied to clipboard

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

Link copied to clipboard
val url: String?

The URL of the picture marker 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 PictureMarkerSymbol 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 marker symbol. 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 PictureMarkerSymbol.height or PictureMarkerSymbol.width to 0.0, then the picture fill symbol will adopt the height and width of the loaded PictureMarkerSymbol.image.

Inherited properties

Link copied to clipboard

The angle (in degrees) that the marker symbol is rotated by. The marker symbol can be rotated relative to the map or the screen, depending on the MarkerSymbol.angleAlignment.

Link copied to clipboard

Indicates whether the marker symbol is rotated relative to the screen or map. If the value is SymbolAngleAlignment.Map, the marker symbol is rotated relative to the map and will be affected by the map's rotation. If the value is SymbolAngleAlignment.Screen, the marker symbol is rotated relative to the user's screen and is unaffected by the map's rotation.

Link copied to clipboard

The callout leader's X offset relative to the marker symbol.

Link copied to clipboard

The callout leader's Y offset relative to the marker symbol.

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

The load status.

Link copied to clipboard

The offset X of the marker symbol relative to the graphic or feature's point geometry.

Link copied to clipboard

The offset Y of the marker symbol relative to the graphic or feature's point geometry.

Functions

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