RouteStop

interface RouteStop

Represents a point that the route must visit.

RouteStop objects are received as part of the route response from route planning API. RouteStop is added to the route response either because the location was requested by the user or because it was automatically generated by the system (see SourceType).

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

Parameters

id

The id that matches a corresponding ItineraryPointId in the routing request if this route stop was requested by the user.

place

Place associated with this route stop.

navigableCoordinates

Coordinates which represent the navigable points of this route stop.

routeOffset

The driving distance from the start of the route to this route stop.

roadSide

The side of the road at which the route point is located.

arrivalEnergy

The level of energy expected at arrival. Optional, present only for electric vehicles if electric consumption is specified in the routing request.

sourceType

Specifies the reason why the route point was added to the route.

chargingInformation

Information on how much to charge at a charging station. Optional, will only be present if this route point is a charging stop in an EV route.

Types

Link copied to clipboard

Specifies the reason why a RouteStop was added to the route.

Properties

Link copied to clipboard
abstract val arrivalEnergy: Energy?
Link copied to clipboard
Link copied to clipboard
abstract val id: RouteStopId
Link copied to clipboard
Link copied to clipboard
abstract val place: Place
Link copied to clipboard
abstract val roadSide: RoadSide?
Link copied to clipboard
abstract val routeOffset: Distance
Link copied to clipboard

Inheritors

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard