com.tomtom.sdk.maps:map-display-compose-common/com.tomtom.sdk.map.display.compose.properties/PolylineProperties

PolylineProperties

The styling and presentation specific properties of a polyline on the map.

The geometry and other polyline data is defined in the PolylineData. The PolylineData and the the properties of this class define how the polyline is visualized on the map.

An instance of this class can be constructed with the PolylineProperties fake constructor function.

Types

Mutable

class Mutable

Mutable variant of PolylineProperties.

Properties

isClickable

val isClickable: Boolean

Sets if the polyline is clickable, if this parameter is false then clicks will be propagated to objects that are below polyline.

lineColor

val lineColor: Int

Main Color of the polyline.

lineEndCapType

val lineEndCapType: CapType

The CapType of the end cap of the Polyline to be created.

lineStartCapType

val lineStartCapType: CapType

The CapType of the start cap of the Polyline to be created.

lineWidths

val lineWidths: List<WidthByZoom>

Widths of the polyline for different zoom levels.

outlineColor

val outlineColor: Int

Outline Color for the polyline overlay.

outlineWidths

val outlineWidths: List<WidthByZoom>

Outline widths of the polyline for different zoom levels.

patternImage

val patternImage: Image?

The pattern Image of the polyline. This image is repeated along the polyline, and it has priority over the solid color from lineColor.

Functions

copy

fun copy(configure: PolylineProperties.Mutable.() -> Unit = { }): PolylineProperties

Copies the PolylineProperties and applies the changes by configure to the copied instance.