RoutePoint

constructor(coordinate: GeoPoint, routeOffset: Distance, travelTime: Duration, remainingBudget: Consumption?)

A GeoPoint on the route together with its distance offset along the route, estimated travel time, and remaining fuel or energy.

Important: This is a Public Preview API. It may be changed or removed at any time.

Parameters

coordinate

GeoPoint from the route polyline.

routeOffset

Distance offset along the route.

travelTime

Travel time (including traffic delay) from the start of the route.

remainingBudget

Remaining fuel or battery charge when reaching this point of the route, as a Consumption.Energy instance. Charging stops are considered in this calculation. Thus, to determine the energy used between two offsets, use the difference in the remaining budget at these points, adding any energy charged at stops in between.

  • The remaining budget is negative if the point is not reachable.

  • It is null if consumption parameters have not been set up, that is, the Vehicle does not have an ElectricEngine.

  • To get the remaining budget at any arbitrary route offset, the method Route.remainingBudgetAt can be used.


constructor(coordinate: GeoPoint, routeOffset: Distance, travelTime: Duration)

Deprecated

This will be removed from future releases after October 10th 2024.

Replace with

constructor(GeoPoint, Distance, Duration, Consumption?)

A GeoPoint on the route together with its distance offset along the route, estimated travel time, and remaining fuel or energy.

Parameters

coordinate

GeoPoint from the route polyline.

routeOffset

Distance offset along the route.

travelTime

Travel time (including traffic delay) from the start of the route.