Instruction

class Instruction(    val routeOffset: Distance = Distance.ZERO,     val length: Distance = Distance.ofMeters(DEFAULT_MANEUVER_LENGTH),     val combineWithNext: Boolean = false,     val startPointIndex: Int = 0)

Represents an instruction arrow on a route.

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

Parameters

routeOffset

The distance from the start of the route to the point of the instruction.

length

The length of the instruction.

combineWithNext

Indicates whether the instruction will be combined with the next item along the route, which can be another instruction, a waypoint or the destination.

Constructors

Link copied to clipboard
fun Instruction(    routeOffset: Distance = Distance.ZERO,     length: Distance = Distance.ofMeters(DEFAULT_MANEUVER_LENGTH),     combineWithNext: Boolean = false,     startPointIndex: Int = 0)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val combineWithNext: Boolean = false
Link copied to clipboard
val length: Distance
Link copied to clipboard
val routeOffset: Distance
Link copied to clipboard
val startPointIndex: Int = 0