CalculateRouteResponse
import type { CalculateRouteResponse } from "https://aws-api.deno.dev/v0.3/services/location.ts?docs=full";
Returns the result of the route calculation. Metadata includes legs and route summary.
§Properties
§
Contains details about each path between a pair of positions included along a route such as: StartPosition
, EndPosition
, Distance
, DurationSeconds
, Geometry
, and Steps
.
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.
§
Summary: CalculateRouteSummary
[src]Contains information about the whole route, such as: RouteBBox
, DataSource
, Distance
, DistanceUnit
, and DurationSeconds
.