MultilayerPointSymbol

class MultilayerPointSymbol : MultilayerSymbol

Multilayer Point symbol This is a point symbol with multiple layers. Each layer has its own properties, such as offset, anchor, and rotation, that can be combined to create a point symbol with special effects (concentric circles or a pushpin, for example). These symbols are rendered with point geometry.

See also

Constructors

Link copied to clipboard
fun MultilayerPointSymbol(symbolLayers: Iterable<SymbolLayer>, referenceProperties: SymbolReferenceProperties? = null)

Creates a multilayer point symbol object with symbol layers and SymbolReferenceProperties.

Functions

Link copied to clipboard
open override fun clone(): MultilayerPointSymbol
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 override fun toJson(): String

Convert an object to JSON string.

Properties

Link copied to clipboard
var angle: Float

The angle in degrees. Angle for multilayer point symbols is measured in degrees counterclockwise from the east, from 0 to 360. The angle for a multilayer point symbol defaults to 0. Marker symbol layers can have a separate heading value defined (which is also 0 by default). Setting a heading for a marker symbol layer does not affect the angle of the point symbol. When an angle value is set for the point symbol, however, that value is applied cumulatively to all the marker symbol layers it contains. The heading for individual symbol layers must be re-fetched in order to see the updated value.

Link copied to clipboard
var angleAlignment: SymbolAngleAlignment

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

Link copied to clipboard
var color: Color

The consensus color of all layers in the symbol (excluding those that are color-locked). Because MultilayerSymbol may have multiple symbol layers, this property represents the value of all color and tint color properties of constituent symbol layers, excluding any StrokeSymbolLayer in a MultilayerPolygonSymbol, as those symbol layers are outlines. The property defines the color and tint color of symbols contained in VectorMarkerSymbolElement. Constituent symbol layers whose colorLocked property is true do not change color as a result of this function. To change outline colors, modify the outline symbol layer colors individually.

Link copied to clipboard
var referenceProperties: SymbolReferenceProperties?
Link copied to clipboard
var size: Float

The symbol size in DIPs. When getting the size from a multilayer point symbol, the value reported is the largest size of all the symbol layers it contains. The symbol size is updated when its symbol layer sizes change (if there is a new largest layer size). When setting a new size at the point symbol level, the size of the largest symbol layer is given the provided value, and all the smaller layers are sized proportionately. An individual symbol layer can be given a specific size without affecting the other layers.

Link copied to clipboard
val symbolLayers: MutableList<SymbolLayer>
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.