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

PictureMarkerSymbol

class PictureMarkerSymbol : MarkerSymbol, Loadable

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

Constructors

PictureMarkerSymbol

fun PictureMarkerSymbol()

Creates a picture marker symbol.

PictureMarkerSymbol

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

Companion

object Companion

Properties

height

var height: Float

The height of the picture marker 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 to visualize this picture marker symbol.

opacity

var opacity: Float

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.

url

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.

width

var width: Float

The width of the picture marker symbol. 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

angle

var angle: Float

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.

angleAlignment

var angleAlignment: SymbolAngleAlignment

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.

leaderOffsetX

var leaderOffsetX: Float

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

leaderOffsetY

var leaderOffsetY: Float

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

loadStatus

open override val loadStatus: StateFlow<LoadStatus>

The load status.

offsetX

var offsetX: Float

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

offsetY

var offsetY: Float

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

Functions

clone

open override fun clone(): PictureMarkerSymbol

Clones the PictureMarkerSymbol.

equals

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

toMultilayerSymbol

fun toMultilayerSymbol(): MultilayerPointSymbol

Gets a MultilayerPointSymbol with a PictureMarkerSymbolLayer from a PictureMarkerSymbol.

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