`RouteLeg`

RouteLeg represents one travel segment between two waypoints.

Constructor

Signature: new RouteLeg(raw: RouteLegData)

Creates a route leg wrapper around raw leg payload.

const leg = new RouteLeg(rawLeg);

Methods

Method	Signature	Purpose
`getRaw`	`getRaw(): RouteLegData`	Return raw leg payload
`getTime`	`getTime(): number`	Get leg travel time
`getDistance`	`getDistance(): number`	Get leg distance
`getSteps`	`getSteps(): RouteLegStep[]`	Get leg steps
`getFromWaypointIndex`	`getFromWaypointIndex(): number`	Get source waypoint index
`getToWaypointIndex`	`getToWaypointIndex(): number`	Get destination waypoint index

getRaw()

Returns raw RouteLegData.

const raw = leg.getRaw();

getTime()

Returns leg time.

const time = leg.getTime();

getDistance()

Returns leg distance.

const distance = leg.getDistance();

getSteps()

Returns all leg steps.

const steps = leg.getSteps();

getFromWaypointIndex()

Returns source waypoint index.

const from = leg.getFromWaypointIndex();

getToWaypointIndex()

Returns destination waypoint index.

const to = leg.getToWaypointIndex();

Example

const leg = new RouteLeg(data);

console.log(leg.getTime(), leg.getDistance());
console.log(leg.getFromWaypointIndex(), leg.getToWaypointIndex());

RouteLegData Interface

This is the original plain data object shape used in API payloads (request/response), not the SDK wrapper class.

interface RouteLegData {
  distance: number;
  time: number;
  steps: RouteLegStepData[];
  from_waypoint_index: number;
  to_waypoint_index: number;
}

Referenced nested interface: RouteLegStepData.

RouteLeg