maplibre-navigation-core/org.maplibre.navigation.core.models/LegAnnotation

LegAnnotation

@Serializable

data class LegAnnotation(val distance: List<Double>? = null, val duration: List<Double>? = null, val speed: List<Double>? = null, val maxSpeed: List<MaxSpeed>? = null, val congestion: List<String>? = null)

An annotations object that contains additional details about each line segment along the route geometry. Each entry in an annotations field corresponds to a coordinate along the route geometry.

Since

2.1.0

Constructors

LegAnnotation

constructor(distance: List<Double>? = null, duration: List<Double>? = null, speed: List<Double>? = null, maxSpeed: List<MaxSpeed>? = null, congestion: List<String>? = null)

Types

Builder

class Builder

Builder class for creating LegAnnotation instances.

Properties

congestion

val congestion: List<String>? = null

The congestion between each pair of coordinates.

distance

val distance: List<Double>? = null

The distance, in meters, between each pair of coordinates.

duration

val duration: List<Double>? = null

The speed, in meters per second, between each pair of coordinates.

maxSpeed

@SerialName(value = "maxspeed")

val maxSpeed: List<MaxSpeed>? = null

The posted speed limit, between each pair of coordinates. Maxspeed is only available for the mapbox/driving and mapbox/driving-traffic profiles, other profiles will return unknowns only.

speed

val speed: List<Double>? = null

The speed, in meters per second, between each pair of coordinates.

Functions

toBuilder

fun toBuilder(): LegAnnotation.Builder

Creates a builder initialized with the current values of the LegAnnotation instance.