PictureMarkerSymbol

class PictureMarkerSymbol : MarkerSymbol, Loadable

Uses an image to symbolize geoelements that have point or multipoint geometry. Supported image formats are BMP, GIF, ICO, JPEG, and PNG. Animated GIF is not supported.

See also

Constructors

Link copied to clipboard
fun PictureMarkerSymbol()

Creates a picture marker symbol object.

Link copied to clipboard
fun PictureMarkerSymbol(image: BitmapDrawable)

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

Link copied to clipboard
fun PictureMarkerSymbol(url: String)

Creates a picture marker 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(): PictureMarkerSymbol
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(): MultilayerPointSymbol

Get Multilayer point symbol generated from picture marker symbol. Given a picture marker symbol, this method will return a MultilayerPointSymbol with a PictureMarkerSymbolLayer.

Properties

Link copied to clipboard
var angle: Float

The angle (in degrees) of the marker symbol.

Link copied to clipboard
var angleAlignment: SymbolAngleAlignment

The symbol angle alignment of the marker symbol. The angle alignment of the marker symbol. Returns SymbolAngleAlignment.Map if an error occurs.

Link copied to clipboard
var height: Float

The height of the picture marker symbol.

Link copied to clipboard
val image: BitmapDrawable?
Link copied to clipboard
var leaderOffsetX: Float

The leader offset X of the marker symbol.

Link copied to clipboard
var leaderOffsetY: Float

The leader offset Y of the marker symbol.

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

The load status.

Link copied to clipboard
var offsetX: Float

The offset X of the marker symbol.

Link copied to clipboard
var offsetY: Float

The offset Y of the marker symbol.

Link copied to clipboard
var opacity: Float

The opacity for the 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 marker symbol.

Link copied to clipboard
var width: Float

The width of the picture marker symbol.