RouteLeg

Initializes a new route leg object with the given JSON dictionary representation and waypoints.

Normally, you do not create instances of this class directly. Instead, you receive route leg objects as part of route objects when you request directions using the Directions.calculateDirections(options:completionHandler:) method.

The starting point of the route leg.

Unless this is the first leg of the route, the source of this leg is the same as the destination of the previous leg.

The endpoint of the route leg.

Unless this is the last leg of the route, the destination of this leg is the same as the source of the next leg.

An array of one or more RouteStep objects representing the steps for traversing this leg of the route.

Each route step object corresponds to a distinct maneuver and the approach to the next maneuver.

This array is empty if the includesSteps property of the original RouteOptions object is set to false.

An array containing OpenStreetMap node identifiers, one for each coordinate along the route geometry.

This property is set if the RouteOptions.attributeOptions property contains .openStreetMapNodeIdentifier.

An array containing the distance (measured in meters) between each coordinate in the route leg geometry.

This property is set if the RouteOptions.attributeOptions property contains .distance.

An array containing the expected travel time (measured in seconds) between each coordinate in the route leg geometry.

These values are dynamic, accounting for any conditions that may change along a segment, such as traffic congestion if the profile identifier is set to .automobileAvoidingTraffic.

This property is set if the RouteOptions.attributeOptions property contains .expectedTravelTime.

An array containing the expected average speed (measured in meters per second) between each coordinate in the route leg geometry.

These values are dynamic; rather than speed limits, they account for the road’s classification and/or any traffic congestion (if the profile identifier is set to .automobileAvoidingTraffic).

This property is set if the RouteOptions.attributeOptions property contains .speed.

An array containing the traffic congestion level along each road segment in the route leg geometry.

Traffic data is available in a number of countries and territories worldwide.

You can color-code a route line according to the congestion level along each segment of the route.

This property is set if the RouteOptions.attributeOptions property contains .congestionLevel.

A name that describes the route leg.

The name describes the leg using the most significant roads or trails along the route leg. You can display this string to the user to help the user can distinguish one route from another based on how the legs of the routes are named.

The leg’s name does not identify the start and end points of the leg. To distinguish one leg from another within the same route, concatenate the name properties of the source and destination waypoints.

The route leg’s distance, measured in meters.

The value of this property accounts for the distance that the user must travel to arrive at the destination from the source. It is not the direct distance between the source and destination, nor should not assume that the user would travel along this distance at a fixed speed.

The route leg’s expected travel time, measured in seconds.

The value of this property reflects the time it takes to traverse the route leg. If the route was calculated using the MBDirectionsProfileIdentifierAutomobileAvoidingTraffic profile, this property reflects current traffic conditions at the time of the request, not necessarily the traffic conditions at the time the user would begin this leg. For other profiles, this property reflects travel time under ideal conditions and does not account for traffic congestion. If the leg makes use of a ferry or train, the actual travel time may additionally be subject to the schedules of those services.

Do not assume that the user would travel along the leg at a fixed speed. For the expected travel time on each individual segment along the leg, use the RouteStep.expectedTravelTimes property. For more granularity, specify the AttributeOptions.expectedTravelTime option and use the expectedSegmentTravelTimes property.

A string specifying the primary mode of transportation for the route leg.

The value of this property is MBDirectionsProfileIdentifierAutomobile, MBDirectionsProfileIdentifierAutomobileAvoidingTraffic, MBDirectionsProfileIdentifierCycling, or MBDirectionsProfileIdentifierWalking, depending on the profileIdentifier property of the original RouteOptions object. This property reflects the primary mode of transportation used for the route leg. Individual steps along the route leg might use different modes of transportation as necessary.