- Summary
- Instance methods
- Properties
- routeId
- metadata
- sections
- geometry
- jamSegments
- events
- speedLimits
- vehicleOptions
- laneSigns
- directionSigns
- restrictedEntries
- trafficLights
- restrictedTurns
- railwayCrossings
- pedestrianCrossings
- speedBumps
- checkpoints
- ruggedRoads
- tollRoads
- fordCrossings
- ferries
- highways
- tunnels
- zoneCrossings
- roadVehicleRestrictions
- manoeuvreVehicleRestrictions
- annotationLanguage
- requestPoints
- position
- routePosition
- legIndex
- isAreConditionsOutdated
- wayPoints
Warning
This feature is available in the Full MapKit SDK version
YMKDrivingRoute
class YMKDrivingRoute : NSObject |
Driving route. A route consists of multiple sections. Each section has a corresponding annotation that describes the action at the beginning of the section.
Summary
Instance methods
func addConditionsListener(with conditionsListener: YMKDrivingConditionsListener) |
func removeConditionsListener(with conditionsListener: YMKDrivingConditionsListener) |
func sectionIndex(withSegmentIndex segmentIndex: UInt) -> UInt |
func metadataAt(with position: YMKPolylinePosition) -> YMKDrivingRouteMetadata |
func requestConditionsUpdate() |
Properties
var routeId: String { get } |
var metadata: YMKDrivingRouteMetadata { get } |
var sections: [YMKDrivingSection] { get } |
var geometry: YMKPolyline { get } |
var jamSegments: [YMKJamSegment] { get } |
var events: [YMKDrivingEvent] { get } |
var speedLimits: [NSNumber] { get } |
var vehicleOptions: YMKDrivingVehicleOptions { get } |
var laneSigns: [YMKDrivingLaneSign] { get } |
var directionSigns: [YMKDrivingDirectionSign] { get } |
var restrictedEntries: [YMKDrivingRestrictedEntry] { get } |
var trafficLights: [YMKDrivingTrafficLight] { get } |
var restrictedTurns: [YMKDrivingRestrictedTurn] { get } |
var railwayCrossings: [YMKDrivingRailwayCrossing] { get } |
var pedestrianCrossings: [YMKDrivingPedestrianCrossing] { get } |
var speedBumps: [YMKDrivingSpeedBump] { get } |
var checkpoints: [YMKDrivingCheckpoint] { get } |
var ruggedRoads: [YMKDrivingRuggedRoad] { get } |
var tollRoads: [YMKDrivingTollRoad] { get } |
var fordCrossings: [YMKDrivingFordCrossing] { get } |
var ferries: [YMKDrivingFerry] { get } |
var highways: [YMKDrivingHighway] { get } |
var tunnels: [YMKDrivingTunnel] { get } |
var zoneCrossings: [YMKDrivingZoneCrossing] { get } |
var roadVehicleRestrictions: [YMKDrivingRoadVehicleRestriction] { get } |
var manoeuvreVehicleRestrictions: [YMKDrivingManoeuvreVehicleRestriction] { get } |
var annotationLanguage: NSNumber? { get } |
var requestPoints: [YMKRequestPoint]? { get } |
var position: YMKPolylinePosition { get set } |
var routePosition: YMKRoutePosition { get } |
var legIndex: UInt { get set } |
var isAreConditionsOutdated: Bool { get } |
var wayPoints: [YMKPolylinePosition] { get } |
Instance methods
addConditionsListener(with:)
func addConditionsListener(with conditionsListener: YMKDrivingConditionsListener) |
Adds a listener for route condition changes.
The class does not retain the object in the 'conditionsListener' parameter. It is your responsibility to maintain a strong reference to the target object while it is attached to a class.
removeConditionsListener(with:)
func removeConditionsListener(with conditionsListener: YMKDrivingConditionsListener) |
Removes the listener for route condition changes.
The class does not retain the object in the 'conditionsListener' parameter. It is your responsibility to maintain a strong reference to the target object while it is attached to a class.
sectionIndex(withSegmentIndex:)
func sectionIndex(withSegmentIndex segmentIndex: UInt) -> UInt |
Section index.
metadataAt(with:)
func metadataAt(with position: YMKPolylinePosition) -> YMKDrivingRouteMetadata |
Metadata location.
requestConditionsUpdate()
func requestConditionsUpdate() |
Undocumented
Properties
routeId
var routeId: String { get } |
The ID of the route.
metadata
var metadata: YMKDrivingRouteMetadata { get } |
The route metadata.
sections
var sections: [YMKDrivingSection] { get } |
Manoeuvre-to-Manoeuvre route sections.
geometry
var geometry: YMKPolyline { get } |
Route geometry.
jamSegments
var jamSegments: [YMKJamSegment] { get } |
Traffic conditions on the given route.
events
var events: [YMKDrivingEvent] { get } |
Events on the given route.
speedLimits
var speedLimits: [NSNumber] { get } |
Speed limits for segments in the geometry.
vehicleOptions
var vehicleOptions: YMKDrivingVehicleOptions { get } |
Vehicle options.
laneSigns
var laneSigns: [YMKDrivingLaneSign] { get } |
Lane signs.
directionSigns
var directionSigns: [YMKDrivingDirectionSign] { get } |
Direction signs.
restrictedEntries
var restrictedEntries: [YMKDrivingRestrictedEntry] { get } |
Route restricted entries.
trafficLights
var trafficLights: [YMKDrivingTrafficLight] { get } |
Route traffic lights.
restrictedTurns
var restrictedTurns: [YMKDrivingRestrictedTurn] { get } |
Route points with time-dependent restrictions.
railwayCrossings
var railwayCrossings: [YMKDrivingRailwayCrossing] { get } |
Railway crossings
pedestrianCrossings
var pedestrianCrossings: [YMKDrivingPedestrianCrossing] { get } |
Pedestrian crossings
speedBumps
var speedBumps: [YMKDrivingSpeedBump] { get } |
Speed bumps
checkpoints
var checkpoints: [YMKDrivingCheckpoint] { get } |
Checkpoints
ruggedRoads
var ruggedRoads: [YMKDrivingRuggedRoad] { get } |
Route roads.
tollRoads
var tollRoads: [YMKDrivingTollRoad] { get } |
Undocumented
fordCrossings
var fordCrossings: [YMKDrivingFordCrossing] { get } |
Undocumented
ferries
var ferries: [YMKDrivingFerry] { get } |
Undocumented
highways
var highways: [YMKDrivingHighway] { get } |
Undocumented
tunnels
var tunnels: [YMKDrivingTunnel] { get } |
Undocumented
zoneCrossings
var zoneCrossings: [YMKDrivingZoneCrossing] { get } |
Undocumented
roadVehicleRestrictions
var roadVehicleRestrictions: [YMKDrivingRoadVehicleRestriction] { get } |
Route vehicle restrictions.
manoeuvreVehicleRestrictions
var manoeuvreVehicleRestrictions: [YMKDrivingManoeuvreVehicleRestriction] { get } |
Undocumented
annotationLanguage
var annotationLanguage: NSNumber? { get } |
Language of string annotations (for example street names) in this route object.
Optional property, can be nil.
requestPoints
var requestPoints: [YMKRequestPoint]? { get } |
Request points that were specified in the router request that this route originated from.
Optional property, can be nil.
position
var position: YMKPolylinePosition { get set } |
The reached position on the given route. The 'RouteMetadata::weight' field contains data for the part of the route beyond this position.
routePosition
var routePosition: YMKRoutePosition { get } |
The reached position on the given route. The 'RouteMetadata::weight' field contains data for the part of the route beyond this position.
legIndex
var legIndex: UInt { get set } |
A leg is a section of the route between two consecutive waypoints.
isAreConditionsOutdated
var isAreConditionsOutdated: Bool { get } |
Indicates whether driving conditions (jamSegments and events) have become outdated when we are not able to fetch updates for some predefined time.
wayPoints
var wayPoints: [YMKPolylinePosition] { get } |
Polyline positions of waypoints including start and finish point.