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.

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

Functions

Link copied to clipboard
fun bringToFront()

Bring the Route to front.

Link copied to clipboard
fun follow()

Mark this Route as followable.

Link copied to clipboard
fun remove()

Remove the Route from the map.

Link copied to clipboard
fun unfollow()

Mark this Route as non followable.

Properties

Link copied to clipboard
val bounds: GeoBoundingBox

Returns a bounding box sized to the Route geometry.

Link copied to clipboard
var color: Color

Mutable property representing the color of the Route tube.

Link copied to clipboard
val departure: GeoCoordinate

Origin location of the Route

Link copied to clipboard
val destination: GeoCoordinate

Destination location of the Route.

Link copied to clipboard
val geometry: List<GeoCoordinate>

Geometry of the Route.

Link copied to clipboard
val id: UniqueId

Unique Route identifier

Link copied to clipboard
var instructions: List<Instruction>

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

Link copied to clipboard
val outlineWidth: Double

Width of the Route outline in pixels.

Link copied to clipboard
var progress: Distance

Mutable property representing the current Route progress in meters.

Link copied to clipboard
val tag: String?

Returns the Route tag.

Link copied to clipboard
val visibility: Boolean

Determines whether the Route is visible or hidden.

Link copied to clipboard
val width: Double

Width of the Route tube in pixels. This takes zoom levels into account, if different route widths have been set for different zoom levels