Skip to main content

RouteProgressEvent

type RouteProgressEvent = object;

From Navigation.addRouteProgressListener and onRouteProgress.

Properties​

PropertyTypeDescription
distanceRemainingnumberMeters.
distanceTravelednumberMeters.
durationRemainingnumberSeconds.
fractionTravelednumber0..1
lanesReadonlyArray<Lane>Lanes at the next maneuver, left to right. Empty if the route has no lane data there.
legIndexCodegenTypes.Int32Index of the current leg, in Route legs.
maneuverInstructionstringPrimary banner text of the next maneuver, e.g. "Turn right onto Market Street".
maneuverModifierstringMapbox Directions maneuver modifier, e.g. "right", "slight left". Empty if unknown.
maneuverTypestringMapbox Directions maneuver type, e.g. "turn", "arrive". Empty if unknown.
secondaryInstructionstringSecondary banner text, e.g. the destination of an exit. Empty if none.
stepDistanceRemainingnumberMeters to the next maneuver.
stepIndexCodegenTypes.Int32Index of the current step in the current leg.
subInstructionstringSub banner text, e.g. "Then turn left". Empty if none or if the sub banner shows lanes.