Leg
import type { Leg } from "https://aws-api.deno.dev/v0.3/services/location.ts?docs=full";
Contains the calculated route's details for each path between a pair of positions. The number of legs returned corresponds to one fewer than the total number of positions in the request.
For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:
- The
StartPosition
is the departure position. - The
EndPosition
is the destination position.
A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:
- Leg 1: The
StartPosition
is the departure position . TheEndPosition
is the waypoint positon. - Leg 2: The
StartPosition
is the waypoint position. TheEndPosition
is the destination position.
§Properties
The distance between the leg's StartPosition
and EndPosition
along a calculated route.
- The default measurement is
Kilometers
unless the request specifies aDistanceUnit
ofMiles
.
The estimated travel time between the leg's StartPosition
and EndPosition
.
The travel mode and departure time that you specify in the request determines the calculated time.
The terminating position of the leg.
Follows the format [longitude,latitude]
.
Note:
If the EndPosition
isn't located on a road, it's snapped to a nearby road.
Contains the calculated route's path as a linestring geometry.
The starting position of the leg.
Follows the format [longitude,latitude]
.
Note:
If the StartPosition
isn't located on a road, it's snapped to a nearby road.