public struct RoutePlace : Hashable

The location information.

  • The type of the route place.

    Declaration

    Swift

    public var type: RoutePlaceType
  • If available, this index corresponds to the waypoint in the original user-defined waypoint list. Otherwise, this waypoint was added during route calculation by the system.

    Declaration

    Swift

    public var waypointIndex: Int32?
  • User-defined geographic coordinates. If not available, it means this place was added during route calculation.

    Declaration

    Swift

    public var originalCoordinates: GeoCoordinates?
  • Map-matched geographic coordinates.

    Declaration

    Swift

    public var mapMatchedCoordinates: GeoCoordinates
  • Location of the Points of Interest (PoI) to be displayed in the visualization. In the map data, PoI have a set of display coordinates as well as a set of access/routing coordinates. While the access/routing coordinates specify the nearest accessible road network location that can be apart from actual location of the PoI, the display coordinates specify the location of the PoI to be displayed accurately in the visualization.

    Declaration

    Swift

    public var displayCoordinates: GeoCoordinates?
  • Estimated battery charge in kWh for electric vehicles when leaving this place. Available only if the route was calculated with EVCarOptions.ensureReachability = true.

    Declaration

    Swift

    public var chargeInKilowattHours: Double?
  • Charging station data for electric vehicles.

    Declaration

    Swift

    public var chargingStation: ChargingStation?
  • Name of a public transit place if available.

    Declaration

    Swift

    public var name: String?
  • Identifier of a public transit place if available.

    Declaration

    Swift

    public var id: String?
  • Platform name or number of a public transit place if available.

    Declaration

    Swift

    public var platform: String?
  • Side of destination: left, right or undefined. nil for transit sections and for origin points. UNDEFINED if originalCoordinates are not identified or too close to the road.

    Declaration

    Swift

    public var sideOfDestination: SideOfDestination?
  • Checks whether the RoutePlace is off-road or not.

    Declaration

    Swift

    public func isOffRoad() -> Bool

    Return Value

    true if the RoutePlace is off-road, false otherwise.