maps:display/com.tomtom.sdk.maps.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.

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

Functions

bringToFront

fun bringToFront()

Bring the Route to front.

fun follow()

Mark this Route as followable.

remove

fun remove()

Remove the Route from the map.

unfollow

fun unfollow()

Mark this Route as non followable.

Properties

bounds

val bounds: GeoBoundingBox

Returns a bounding box sized to the Route geometry.

color

var color: Color

Mutable property representing the color of the Route tube.

departure

val departure: GeoCoordinate

Origin location of the Route

destination

val destination: GeoCoordinate

Destination location of the Route.

geometry

val geometry: List<GeoCoordinate>

Geometry of the Route.

val id: UniqueId

Unique Route identifier

instructions

var instructions: List<Instruction>

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

outlineWidth

val outlineWidth: Double

Width of the Route outline in pixels.

progress

var progress: Distance

Mutable property representing the current Route progress in meters.

tag

val tag: String?

Returns the Route tag.

visibility

val visibility: Boolean

Determines whether the Route is visible or hidden.

width

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