ManeuverOptions

class ManeuverOptions

Specifies options for parsing Maneuver data in the MapboxManeuverApi.

Parameters

filterDuplicateManeuvers

guidance instructions returned by the Mapbox Directions API often have instructions on a route duplicated to control the timing of when to notify the user about details of an upcoming maneuver. For example, there can a "left turn" BannerInstructions available 1000m and 300m before a turn, where only the latter also contains lane information. By setting this flag to true, you can filter out those duplicates which improves the presentation in, for example, a scrolling list.

The MapboxManeuverApi will ensure that no information is lost and the current maneuver is always up-to-date. It's only the upcoming duplicates that are continuously filtered out.

This option defaults to true.

Types

Builder
Link copied to clipboard
class Builder
Builder of ManeuverOptions

Functions

equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Regenerate whenever a change is made
hashCode
Link copied to clipboard
open override fun hashCode(): Int
Regenerate whenever a change is made
toBuilder
Link copied to clipboard
fun toBuilder(): ManeuverOptions.Builder
toString
Link copied to clipboard
open override fun toString(): String
Regenerate whenever a change is made

Properties

filterDuplicateManeuvers
Link copied to clipboard
val filterDuplicateManeuvers: Boolean
guidance instructions returned by the Mapbox Directions API often have instructions on a route duplicated to control the timing of when to notify the user about details of an upcoming maneuver.