RouteLeg

A RouteLeg object defines a single leg of a route between two waypoints. If the overall route has only two waypoints, it has a single RouteLeg object that covers the entire route. The route leg object includes information about the leg, such as its name, distance, and expected travel time. Depending on the criteria used to calculate the route, the route leg object may also include detailed turn-by-turn instructions.

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.calculate(_:completionHandler:) method.

  • Foreign attribute arrays associated with this leg.

    This library does not officially support any attribute that is documented as a “beta” annotation type in the Mapbox Directions API response format, but you can get and set it as an element of this JSONObject. It is round-tripped to the annotation property in JSON.

    For non-attribute-related foreign members, use the foreignMembers property.

  • See more

Creating a Leg

Getting the Endpoints of the Leg

  • 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.

    This property is set to nil if the leg was decoded from a JSON RouteLeg object.

  • 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.

    This property is set to nil if the leg was decoded from a JSON RouteLeg object.

Getting the Steps Along the 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 original RouteOptions object’s RouteOptions.includesSteps property is set to false.

  • The ranges of each step’s segments within the overall leg.

    Each range corresponds to an element of the steps property. Use this property to safely subscript segment-based properties such as segmentCongestionLevels and segmentMaximumSpeedLimits.

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

Getting Per-Segment Attributes Along the Leg

  • 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 AttributeOptions.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 AttributeOptions.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 AttributeOptions.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 AttributeOptions.congestionLevel.

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

    Entries may be nil if congestion on that segment is not known.

    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 AttributeOptions.numericCongestionLevel.

  • An array containing the maximum speed limit along each road segment along the route leg’s shape.

    The maximum speed may be an advisory speed limit for segments where legal limits are not posted, such as highway entrance and exit ramps. If the speed limit along a particular segment is unknown, it is represented in the array by a measurement whose value is negative. If the speed is unregulated along the segment, such as on the German Autobahn system, it is represented by a measurement whose value is Double.infinity.

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

    This property is set if the RouteOptions.attributeOptions property contains AttributeOptions.maximumSpeedLimit.

  • An array of Closure objects describing live-traffic related closures that occur along the route.

    This information is only available for the mapbox/driving-traffic profile and when RouteOptions.attributeOptions property contains AttributeOptions.closures.

  • Returns the ISO 3166-1 alpha-2 region code for the administrative region through which the given intersection passes. The intersection is identified by its step index and intersection index.

    Seealso

    Intersection.regionCode

Getting Statistics About the Leg

  • 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 ProfileIdentifier.automobileAvoidingTraffic 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.

  • The administrative regions through which the leg passes.

    Items are ordered by appearance, most recent one is at the beginning. This property is set to nil if no administrative region data is available. You can alse refer to Incident.regionCode to get corresponding region string code.

  • Contains Incidents data which occur during current RouteLeg.

    Items are ordered by appearance, most recent one is at the beginning. This property is set to nil if incidents data is not available.

  • Describes where a particular Waypoint passed to RouteOptions matches to the route along a RouteLeg.

    The property is non-nil when for one or several Waypoint objects passed to RouteOptions have separatesLegs property set to false.

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

    The value of this property reflects the typical time it takes to traverse the route leg. This property is available when using the ProfileIdentifier.automobileAvoidingTraffic profile. This property reflects typical traffic conditions at the time of the request, not necessarily the typical traffic conditions at the time the user would begin this leg. If the leg makes use of a ferry, the typical travel time may additionally be subject to the schedule of this service.

    Do not assume that the user would travel along the route at a fixed speed. For more granular typical travel times, use the RouteStep.typicalTravelTime property.

Reproducing the Route