PolylineOptions

data class PolylineOptions(var coordinates: List<GeoPoint>, val lineColor: Color = DEFAULT_LINE_COLOR, val lineWidths: List<WidthByZoom> = listOf(WidthByZoom(DEFAULT_LINE_WIDTH)), val outlineColor: Color = DEFAULT_OUTLINE_COLOR, val outlineWidths: List<WidthByZoom> = listOf(WidthByZoom(DEFAULT_OUTLINE_WIDTH)), val lineStartCapType: CapType = DEFAULT_START_CAP_TYPE, val lineEndCapType: CapType = DEFAULT_END_CAP_TYPE, val isClickable: Boolean = true)

Configures options for a Polyline overlay which can be added and displayed on the map. See the TomTomMap.addPolyline(options: PolylineOptions) to check how to add a new Polyline.

Important: This is a Public Preview API. It may be changed or removed at any time.

See also

, which describes its properties in a more detailed way.

Parameters

coordinates

Coordinates of the line.

lineColor

Main Color of the polyline.

lineWidths

Widths of the polyline for different zoom levels.

outlineColor

Outline Color for the polyline overlay.

outlineWidths

Outline widths of the polyline for different zoom levels.

lineStartCapType

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

lineEndCapType

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

isClickable

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

Constructors

Link copied to clipboard
fun PolylineOptions(coordinates: List<GeoPoint>, lineColor: Color = DEFAULT_LINE_COLOR, lineWidths: List<WidthByZoom> = listOf(WidthByZoom(DEFAULT_LINE_WIDTH)), outlineColor: Color = DEFAULT_OUTLINE_COLOR, outlineWidths: List<WidthByZoom> = listOf(WidthByZoom(DEFAULT_OUTLINE_WIDTH)), lineStartCapType: CapType = DEFAULT_START_CAP_TYPE, lineEndCapType: CapType = DEFAULT_END_CAP_TYPE, isClickable: Boolean = true)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard
val isClickable: Boolean = true
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard