com.tomtom.sdk.maps:map-display-api/com.tomtom.sdk.map.display.route/Route

Route

class Route

A Route representation which can be added and displayed on the map.

See the TomTomMap.addRoute(routeOptions: RouteOptions) to check how to add a new Route.

Properties

areInstructionsVisible

var areInstructionsVisible: Boolean

Mutable property representing the visibility of the instructions on route.

val bounds: GeoBoundingBox

Returns a bounding box sized to the Route geometry.

Mutable property representing the color of the Route tube.

val departure: GeoPoint

Origin location of the Route.

val destination: GeoPoint

Destination location of the Route.

val geometry: List<GeoPoint>

Geometry of the Route.

val id: UniqueId

Unique Route identifier.

var instructions: List<Instruction>

Mutable property representing a list of Instructions associated with this Route.

val outlineWidth: Double

Width of the Route outline in density-independent pixels (dp).

var progress: Distance

Mutable property representing the current Route progress.

val tag: String?

Returns the Route tag.

val visibility: Boolean

Determines whether the Route is visible or hidden.

val width: Double

Width of the Route tube in density-independent pixels (dp). This takes zoom levels into account, if different route widths have been set for different zoom levels

Functions

fun bringToFront()

Bring the Route to front.

fun follow()

Mark this Route as followable.

fun remove()

Remove the Route from the map.

Mark this Route as non followable.