RouteStop

public struct RouteStop

The point of the route that is received from the route planning API.

Important

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

Lifecycle


                    
                    
                    init(id:place:navigableCoordinates:routeOffset:roadSide:arrivalEnergy:chargingInformation:sourceType:)

Initializer

Declaration

Swift

public init(
    id: UUID,
    place: Place,
    navigableCoordinates: [CLLocationCoordinate2D],
    routeOffset: Measurement<UnitLength>,
    roadSide: RoadSide? = nil,
    arrivalEnergy: Measurement<UnitEnergy>? = nil,
    chargingInformation: ChargingInformation? = nil,
    sourceType: SourceType = .userDefined
)

Parameters

`id`	The id that matches a corresponding `ItineraryPoint`.
`place`	A `Place` associated with this `RouteStop`.
`navigableCoordinates`	Coordinates that represent the navigable points of this `RouteStop`.
`routeOffset`	The driving distance from the start of the route to this `RouteStop`.
`roadSide`	The side of the road where `RouteStop` is located. Nil if the side of the road is unknown or not relevant.
`arrivalEnergy`	The energy level expected at arrival to this `RouteStop`. Should only be present for electric vehicles.
`chargingInformation`	Information on how much to charge at a charging station. It will only be present if this `RouteStop` is a charging stop on an EV route.
`sourceType`	The `SourceType` of this `RouteStop`.

Public

id
The id that matches a corresponding ItineraryPoint.
Declaration
Swift

public let id: UUID
place
A Place associated with this RouteStop.
Declaration
Swift

public let place: Place
navigableCoordinates
Coordinates of the navigable points of this RouteStop.
Declaration
Swift

public let navigableCoordinates: [CLLocationCoordinate2D]
routeOffset
The driving distance from the start of the route to this RouteStop.
Declaration
Swift

public let routeOffset: Measurement<UnitLength>
roadSide
The side of the road where RouteStop is located. Nil if the side of the road is unknown or not relevant.
Declaration
Swift

public var roadSide: RoadSide?
arrivalEnergy
The energy level expected at arrival to this RouteStop. Should only be present for electric vehicles.
Declaration
Swift

public let arrivalEnergy: Measurement<UnitEnergy>?
chargingInformation
Information on how much to charge at a charging station. It will only be present if this RouteStop is a charging stop on an EV route.
Declaration
Swift

public let chargingInformation: ChargingInformation?
sourceType
The SourceType of this RouteStop.
Declaration
Swift

public let sourceType: SourceType