Interface RequestRoutesOptions

Options passed to MapboxNavigation.requestRoutes.

interface RequestRoutesOptions {
    alternatives?: boolean;
    avoid?: AvoidFeature[];
    language?: string;
    profile: RoutingProfile;
    steps?: boolean;
    waypoints: Waypoint[];
}

Index

Properties

alternatives? avoid? language? profile steps? waypoints

Properties

`Optional`alternatives

alternatives?: boolean

Request alternative routes. Default: false.

`Optional`avoid

avoid?: AvoidFeature[]

`Optional`language

language?: string

BCP-47 language code for instructions. Default: device locale.

profile

profile: RoutingProfile

`Optional`steps

steps?: boolean

Include step-level data. Default: true.

waypoints

waypoints: Waypoint[]

Minimum 2. First is the origin, last is the final destination.