com.tomtom.sdk.maps:map-display-common-internal/com.tomtom.sdk.map.display.polyline/Polyline

Polyline

class Polyline

A Polyline overlay which was added to the map.

See also

TomTomMap.addPolyline(options: PolylineOptions) to check how to add configure and add a new Polyline.

Properties

Link copied to clipboard
var coordinates: List<GeoPoint>

Determines a List of GeoPoint elements creating the Polyline.

Link copied to clipboard
var endCap: CapType

The CapType of the end cap of the created Polyline.

Link copied to clipboard
val id: UniqueId

Unique Polyline identifier.

Link copied to clipboard
var isVisible: Boolean

Determines whether the Polyline is visible or hidden.

Link copied to clipboard
@get:ColorInt
@set:ColorInt
var lineColor: Int

The inner Color of the Polyline.

Link copied to clipboard
var lineWidths: List<WidthByZoom>

The inner widths (width per zoom level) of the Polyline.

Link copied to clipboard
@get:ColorInt
@set:ColorInt
var outlineColor: Int

The outline Color of the Polyline.

Link copied to clipboard
var outlineWidths: List<WidthByZoom>

The outline widths (width per zoom level) of the Polyline.

Link copied to clipboard
var startCap: CapType

The CapType of the start cap of the created Polyline.

Functions

Link copied to clipboard
fun getPatternImageDescriptor(): ImageDescriptor?

Get the current image descriptor of the pattern image.

Link copied to clipboard
fun remove()

Removes the Polyline from the map.

Link copied to clipboard
fun setGeoJsonProperties(properties: Properties)

Update the polyline with properties from GeoJson.

Link copied to clipboard
fun setPatternImage(image: Image?)

Update the pattern image for this Polyline.