maplibre-navigation-core/org.maplibre.navigation.core.routeprogress/CurrentLegAnnotation

CurrentLegAnnotation

data class CurrentLegAnnotation(val index: Int, val distanceToAnnotation: Double, val distance: Double, val duration: Double?, val speed: Double?, val maxSpeed: MaxSpeed?, val congestion: String? = null)

This class represents the current annotation being traveled along at a given time during navigation.

The Mapbox Directions API gives a list of annotations, each item in the list representing an annotation between two points along the leg.

Since

0.13.0

Constructors

CurrentLegAnnotation

constructor(index: Int, distanceToAnnotation: Double, distance: Double, duration: Double?, speed: Double?, maxSpeed: MaxSpeed?, congestion: String? = null)

Properties

congestion

val congestion: String? = null

The congestion for the given annotation segment.

distance

val distance: Double

The distance, in meters, for the given annotation segment.

distanceToAnnotation

val distanceToAnnotation: Double

Distance along the org.maplibre.navigation.core.models.RouteLeg that adds up to this set of annotation data.

duration

val duration: Double?

The speed, in meters per second, for the given annotation segment.

index

val index: Int

The index used to retrieve the annotation values from each array in org.maplibre.navigation.core.models.

maxSpeed

val maxSpeed: MaxSpeed?

The posted speed limit, for the given annotation segment. Maxspeed is only available for the mapbox/driving and mapbox/driving-traffic profiles, other profiles will return unknowns only.

speed

val speed: Double?

The speed, in meters per second, for the given annotation segment.