maps:display/com.tomtom.sdk.maps.display.route/RouteOptions

RouteOptions

data class RouteOptions( val geometry: List<GeoCoordinate>, val color: Color = DEFAULT_COLOR, val outlineWidth: Double = DEFAULT_OUTLINE_WIDTH, val widths: List<WidthByZoom> = DEFAULT_WIDTHS_BY_ZOOM_LEVELS, val visible: Boolean = true, val progress: Distance = Distance.ZERO, val instructions: List<Instruction> = emptyList(), val tag: String? = null, val departureMarkerVisible: Boolean = false, val destinationMarkerVisible: Boolean = false)

Configures options for a Route representation which can be added and displayed on the map. See TomTomMap.addRoute(routeOptions: RouteOptions).

Parameters

geometry

Geometry of the Route.

color

Color of the route tube.

outlineWidth

Width of the route outline.

widths

Widths of the route tube for different zoom levels. If the same width should be applied for all zoom levels, then the zoom value can be skipped in the WidthByZoom initialization.

visible

Determines the visibility of the Route.

progress

Sets the route progress in meters. The internal map mechanism automatically renders the driven route part in a slightly different color what brings a nice user experience.

instructions

List of Instruction for maneuvers along the Route.

tag

Optional holder for custom extra information about the requested Route.

departureMarkerVisible

Determines the visibility of the default departure marker.

destinationMarkerVisible

Determines the visibility of the default destination marker.

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

Constructors

RouteOptions

fun RouteOptions( geometry: List<GeoCoordinate>, color: Color = DEFAULT_COLOR, outlineWidth: Double = DEFAULT_OUTLINE_WIDTH, widths: List<WidthByZoom> = DEFAULT_WIDTHS_BY_ZOOM_LEVELS, visible: Boolean = true, progress: Distance = Distance.ZERO, instructions: List<Instruction> = emptyList(), tag: String? = null, departureMarkerVisible: Boolean = false, destinationMarkerVisible: Boolean = false)