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

Link copied to clipboard

Returns a bounding box sized to the Route geometry.

Link copied to clipboard
var color: Int

Mutable property representing the color of the Route tube.

Link copied to clipboard

Origin location of the Route.

Link copied to clipboard

Destination location of the Route.

Link copied to clipboard

Geometry of the Route.

Link copied to clipboard

Unique Route identifier.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Mutable property representing the current Route progress.

Link copied to clipboard
val tag: String?

Returns the Route tag.

Link copied to clipboard

Determines whether the Route is visible or hidden.

Link copied to clipboard

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

Link copied to clipboard

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.