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

SimpleLineSymbol

Used to draw linear features on a layer. Simple line symbols display graphics using predefined line style patterns such as solid, dash, dot, etc.

Constructors

SimpleLineSymbol

fun SimpleLineSymbol( style: SimpleLineSymbolStyle = SimpleLineSymbolStyle.Solid, color: Color = Color.white, width: Float = 1.0f, markerStyle: SimpleLineSymbolMarkerStyle = SimpleLineSymbolMarkerStyle.None, markerPlacement: SimpleLineSymbolMarkerPlacement = SimpleLineSymbolMarkerPlacement.End)

Creates a simple line symbol object with some initial values.

Functions

clone

open override fun clone(): SimpleLineSymbol

Clones the SimpleLineSymbol.

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.

equals

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

hashCode

open override fun hashCode(): Int

toJson

open override fun toJson(): String

Convert an object to JSON string.

toMultilayerSymbol

fun toMultilayerSymbol(): MultilayerPolylineSymbol

Get Multilayer polyline symbol generated from simple line symbol. Multilayer symbol API allows users to create complex and custom symbols with multiple layers of different type of symbology. Simple line symbol offers a factory of styles like dash, dash_dot_dot etc. This helper method exports this symbol to MultilayerPolylineSymbol with SolidStrokeSymbolLayer and predefined collection of DashGeometricEffect.

Properties

antiAlias

var antiAlias: Boolean

The anti-alias setting of the line symbol.

color

var color: Color

The color for the line symbol. When getting the color (or tint color) from a symbol, the consensus value (for all layers) is reported. If there is no consensus (one or more layers have different colors), a null value is reported for the color. Likewise, setting a value for color on a symbol will apply that color to all layers the symbol contains.

markerPlacement

var markerPlacement: SimpleLineSymbolMarkerPlacement

The simple line symbol end marker placement of the simple line symbol.

markerStyle

var markerStyle: SimpleLineSymbolMarkerStyle

The simple line symbol end marker style of the simple line symbol.

style

var style: SimpleLineSymbolStyle

The style of the simple line symbol. SimpleLineSymbolStyle.Solid if an error occurs.

unknownJson