PictureMarkerSymbolLayer

A struct that implements picture marker symbol layers. A PictureMarkerSymbolLayer represents a symbol layer used to place a picture marker on a point geometry.

This symbol layer, in a MultilayerPointSymbol, places a picture marker at the location of the point feature. The class supports changing dimensions of the marker, specifying the image (or URI linking to the image) to use as the marker, as well as the general marker options provided by the MarkerSymbolLayer base class.

This symbol layer is similar to the Web Scene specification's IconSymbol3DLayer, when the IconSymbol3DLayer references an image. PictureMarkerSymbolLayer is also similar to the Web Map specification's PictureMarkerSymbol. As a symbol layer, PictureMarkerSymbolLayer can be combined with other symbol layers in a MultilayerSymbol, whereas PictureMarkerSymbol cannot.

Since

200.1.0

Constructors

Link copied to clipboard
constructor(uri: String)

Creates a picture marker symbol layer from a URI. This function sets up the following default properties: Anchor at (0, 0), offset of (0, 0), size of 13.33 DIPs (10 points), an angle of 0 degrees, width and height of (0, 0), and a null image. The function sets the URI to the string provided. After creating, call PictureMarkerSymbolLayer.load() to load the image from the URI.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The image of a picture marker symbol layer. Setting the image of a PictureMarkerSymbolLayer modifies the picture used for rendering the marker.

Link copied to clipboard

The tint color of a picture marker symbol layer. The tint color is applied to the entire image by multiplying each RGB color channel in the image by the corresponding color channel of the tint color. The default tint color is white with 100% opacity, i.e. RGBA(255, 255, 255, 255), which leaves the image with its native colors. A white tint color with opacity less than 100% tints the image white, with the reduced opacity respected.

Link copied to clipboard
val uri: String?

The URI of the image to be loaded in a picture marker symbol layer. Setting the URI changes the URI property of Loadable, from which PictureMarkerSymbolLayer inherits. The URI is an empty string by default. The URI cannot be set after attempting to load. To load the image at the specified URI, call PictureMarkerSymbolLayer.load().

Inherited properties

Link copied to clipboard

The anchor object of a marker symbol layer. The SymbolAnchor determines how the MarkerSymbolLayer is anchored. SymbolAnchor specifies the marker's anchor point and anchor placement mode. The default symbol anchor is at XYZ(0, 0, 0) and uses 'relative' mode. See the SymbolAnchor documentation for a detailed description of the object.

Link copied to clipboard

The marker symbol layer's heading: the angle of rotation about the anchor point. The input value can be any real number. The default value is 0. This property affects markers in both maps and scenes. Positive angles rotate the marker counterclockwise.

Link copied to clipboard

The symbol layer color locked property. The color-locked status of the symbol layer. If color_locked is true, the color of that layer will not change.

Link copied to clipboard

The symbol layer enabled property. The enable status of the symbol layer. Layer will be rendered only if it is enabled.

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

The load status.

Link copied to clipboard

The marker symbol layer's x-offset. The input value can be any real number. The default value is 0. This property affects markers in both Maps and Scenes. The x-offset is a delta applied to the marker in the direction corresponding to the given value. For example, a positive x-offset moves the marker in the positive-x direction.

Link copied to clipboard

The marker symbol layer's y-offset. The input value can be any real number. The default value is 0. This property affects markers in both Maps and Scenes. The y-offset is a delta applied to the marker in the direction corresponding to the given value. For example, a positive y-offset moves the marker in the positive-y direction.

Link copied to clipboard

The size of marker symbol layer. The input value can be any positive number. The default value is 13.333 DIPs (10 points). A larger size means a larger marker.

Functions

Link copied to clipboard

Inherited functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

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.