Citymapper SDK/com.citymapper.sdk.navigation.progress/LegProgress

LegProgress

data class LegProgress(legIndex: Int, leg: Leg, distanceRemaining: Distance, durationRemaining: Duration?, fractionAlongLegDistance: Float, nextInstructionProgress: InstructionProgress?)

Properties

distanceMetersRemaining

val distanceMetersRemaining: Float

The distance in meters remaining along the current leg's path

distanceRemaining

val distanceRemaining: Distance

The distance remaining along the current leg's path

durationRemaining

val durationRemaining: Duration?

The estimated time until reaching the end of the current leg

durationSecondsRemaining

val durationSecondsRemaining: Int?

The estimated seconds until reaching the end of the current leg

fractionAlongLegDistance

val fractionAlongLegDistance: Float

The fraction travelled so far along the entire distance of the current leg's path

leg

val leg: Leg

The leg object at legIndex in the active route

legIndex

val legIndex: Int

The index of the leg in the route the user is currently on

nextInstructionProgress

val nextInstructionProgress: InstructionProgress?

Progress towards the upcoming instruction on the current leg

remainingInstructionSegmentsAfterNext

val remainingInstructionSegmentsAfterNext: List<InstructionSegment>?

A convenience property for getting the list of remaining instructions in this leg beyond the upcoming one. This might be used e.g. in an expanded UI after interacting with the upcoming instruction view, displaying the list of all incomplete instructions