MatchedRouteRequestOptions
type MatchedRouteRequestOptions = object;
Defined in: src/Route.ts:165
Options of Navigation.requestMatchedRoutes.
Properties
| Property | Type | Description |
|---|---|---|
coordinates | Position[] | The path to follow, 2 to 100 coordinates in order. Each is snapped to the nearest road within its radius, so a sparse trace works. |
language? | string | Language of instructions, e.g. en or de-DE. |
profile? | RouteRequestOptions["profile"] | Mapbox Map Matching profile. Defaults to driving-traffic. |
radiuses? | number[] | Meters each coordinate may be away from the road, one per coordinate, 0 to 50. The API defaults to 5. |
units? | "metric" | "imperial" | Unit of the distances in voice instructions. |
waypointIndices? | number[] | Indices of the coordinates that are waypoints: the route is split into legs there and guidance announces the arrival. Must be ascending and include the first and last index. Defaults to the first and last coordinate. |