MultilayerPolylineSymbol

A polyline symbol built with multiple layers of symbols to display graphics and features that have polyline geometry. A MultilayerPolylineSymbol can contain multiple layers that are combined to create different appearances, for example, a solid road with dashed pattern on top to show the center line. The individual layers have their own properties such as width and dash patterns, and can be accessed programmatically through MultilayerSymbol.symbolLayers. For more information about multilayer symbols, refer to https://pro.arcgis.com/en/pro-app/latest/help/mapping/layer-properties/symbol-layers.htm.

If you create a MultilayerPolylineSymbol from a collection of SymbolLayer objects, the first symbol layer in the collection will be drawn first, with the second symbol layer on top of the first, and so on. Note that symbol layers in a multilayer symbol are in reverse order of how they appear in the JSON representation.

Since

200.1.0

See also

Constructors

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

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

Properties

Link copied to clipboard

The width of the symbol in device-independent pixels (DIPs). When getting the width from a multilayer polyline symbol, the value reported is the largest width of all the symbol layers it contains. The symbol width is updated when its symbol layer widths change (if there is a new largest layer width). When setting a new width at the polyline symbol level, the width 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 width without affecting the other layers.

Inherited properties

Link copied to clipboard

The consensus color of all layers in the symbol (excluding those that are color-locked). A MultilayerSymbol may have many 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

The properties change how the multilayer symbol behaves when attached to a renderer.

Link copied to clipboard

The symbol layers of the multilayer symbol. Symbol layers in a multilayer symbol are in reverse order of how they appear in the JSON representation from the server.

Functions

Link copied to clipboard

Inherited functions

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.