RouteRequestOptions
type RouteRequestOptions = object;
Defined in: src/Route.ts:45
Options of Navigation.requestRoutes.
Properties
| Property | Type | Description |
|---|---|---|
alternatives? | boolean | Also return alternative routes. Defaults to false. |
arriveBy? | string | Desired arrival time as YYYY-MM-DDThh:mm, in the local time at the destination. driving only. |
departAt? | string | Departure time as YYYY-MM-DDThh:mm, in the local time at the origin. The route and its travel time take predicted traffic and timed restrictions at that time into account. driving and driving-traffic only. |
exclude? | string[] | Road classes to avoid, e.g. ['toll', 'ferry']. |
excludePoints? | Position[] | Locations to avoid, at most 50. Each is snapped to the nearest road, and the route avoids that road segment where it can. driving and driving-traffic only. |
language? | string | Language of instructions, e.g. en or de-DE. |
maxHeight? | number | Vehicle height in meters, 0 to 10. The route avoids roads with a lower height limit. The Directions API assumes 1.6 if unset. driving and driving-traffic only. |
maxWeight? | number | Vehicle weight in metric tons, 0 to 100. The route avoids roads with a lower weight limit. The Directions API assumes 2.5 if unset. driving and driving-traffic only. |
maxWidth? | number | Vehicle width in meters, 0 to 10. The route avoids roads with a lower width limit. The Directions API assumes 1.9 if unset. driving and driving-traffic only. |
profile? | "driving-traffic" | "driving" | "walking" | "cycling" | Mapbox Directions profile. Defaults to driving-traffic. |
units? | "metric" | "imperial" | Unit of the distances in voice instructions. |
waypoints | Waypoint[] | Origin first, destination last. |