RouteOptions

open class RouteOptions : DirectionsOptions

A RouteOptions object is a structure that specifies the criteria for results returned by the Mapbox Directions API.

Pass an instance of this class into the Directions.calculate(_:completionHandler:) method.

  • Initializes a route options object for routes between the given waypoints and an optional profile identifier.

    Declaration

    Swift

    public required init(waypoints: [Waypoint], profileIdentifier: DirectionsProfileIdentifier? = nil)

    Parameters

    waypoints

    An array of Waypoint objects representing locations that the route should visit in chronological order. The array should contain at least two waypoints (the source and destination) and at most 25 waypoints. (Some profiles, such as DirectionsProfileIdentifier.automobileAvoidingTraffic, may have lower limits.)

    profileIdentifier

    A string specifying the primary mode of transportation for the routes. DirectionsProfileIdentifier.automobile is used by default.

  • Initializes a route options object for routes between the given locations and an optional profile identifier.

    Note

    This initializer is intended for CLLocation objects created using the CLLocation.init(latitude:longitude:) initializer. If you intend to use a CLLocation object obtained from a CLLocationManager object, consider increasing the horizontalAccuracy or set it to a negative value to avoid overfitting, since the Waypoint class’s coordinateAccuracy property represents the maximum allowed deviation from the waypoint.

    Declaration

    Swift

    public convenience init(locations: [CLLocation], profileIdentifier: DirectionsProfileIdentifier? = nil)

    Parameters

    locations

    An array of CLLocation objects representing locations that the route should visit in chronological order. The array should contain at least two locations (the source and destination) and at most 25 locations. Each location object is converted into a Waypoint object. This class respects the CLLocation class’s coordinate and horizontalAccuracy properties, converting them into the Waypoint class’s coordinate and coordinateAccuracy properties, respectively.

    profileIdentifier

    A string specifying the primary mode of transportation for the routes. DirectionsProfileIdentifier.automobile is used by default.

  • Initializes a route options object for routes between the given geographic coordinates and an optional profile identifier.

    Declaration

    Swift

    public convenience init(coordinates: [CLLocationCoordinate2D], profileIdentifier: DirectionsProfileIdentifier? = nil)

    Parameters

    coordinates

    An array of geographic coordinates representing locations that the route should visit in chronological order. The array should contain at least two locations (the source and destination) and at most 25 locations. Each coordinate is converted into a Waypoint object.

    profileIdentifier

    A string specifying the primary mode of transportation for the routes. DirectionsProfileIdentifier.automobile is used by default.

  • Initializes an equivalent route options object from a match options object. Desirable for building a navigation experience from map matching.

    Declaration

    Swift

    public convenience init(matchOptions: MatchOptions)

    Parameters

    matchOptions

    The MatchOptions that is being used to convert to a RouteOptions object.

  • A Boolean value that indicates whether a returned route may require a point U-turn at an intermediate waypoint.

    If the value of this property is true, a returned route may require an immediate U-turn at an intermediate waypoint. At an intermediate waypoint, if the value of this property is false, each returned route may continue straight ahead or turn to either side but may not U-turn. This property has no effect if only two waypoints are specified.

    Set this property to true if you expect the user to traverse each leg of the trip separately. For example, it would be quite easy for the user to effectively “U-turn” at a waypoint if the user first parks the car and patronizes a restaurant there before embarking on the next leg of the trip. Set this property to false if you expect the user to proceed to the next waypoint immediately upon arrival. For example, if the user only needs to drop off a passenger or package at the waypoint before continuing, it would be inconvenient to perform a U-turn at that location.

    The default value of this property is false when the profile identifier is DirectionsProfileIdentifier.automobile or DirectionsProfileIdentifier.automobileAvoidingTraffic and true otherwise.

    Declaration

    Swift

    open var allowsUTurnAtWaypoint: Bool
  • The route classes that the calculated routes will avoid.

    Currently, you can only specify a single road class to avoid.

    Declaration

    Swift

    open var roadClassesToAvoid: RoadClasses
  • A number that influences whether the route should prefer or avoid alleys or narrow service roads between buildings.

    This property has no effect unless the profile identifier is set to DirectionsProfileIdentifier.automobile or DirectionsProfileIdentifier.walking.

    The value of this property must be at least DirectionsPriority.low and at most DirectionsPriority.high. The default value of DirectionsPriority.default neither prefers nor avoids alleys, while a negative value between DirectionsPriority.low and DirectionsPriority.default avoids alleys, and a positive value between DirectionsPriority.default and DirectionsPriority.high prefers alleys. A value of 0.9 is suitable for pedestrians who are comfortable with walking down alleys.

    Declaration

    Swift

    open var alleyPriority: DirectionsPriority
  • A number that influences whether the route should prefer or avoid roads or paths that are set aside for pedestrian-only use (walkways or footpaths).

    This property has no effect unless the profile identifier is set to DirectionsProfileIdentifier.walking. You can adjust this property to avoid sidewalks and crosswalks that are mapped as separate footpaths, which may be more granular than needed for some forms of pedestrian navigation.

    The value of this property must be at least DirectionsPriority.low and at most DirectionsPriority.high. The default value of DirectionsPriority.default neither prefers nor avoids walkways, while a negative value between DirectionsPriority.low and DirectionsPriority.default avoids walkways, and a positive value between DirectionsPriority.default and DirectionsPriority.high prefers walkways. A value of −0.1 results in less verbose routes in cities where sidewalks and crosswalks are generally mapped as separate footpaths.

    Declaration

    Swift

    open var walkwayPriority: DirectionsPriority
  • The expected uniform travel speed measured in meters per second.

    This property has no effect unless the profile identifier is set to DirectionsProfileIdentifier.walking. You can adjust this property to account for running or for faster or slower gaits. When the profile identifier is set to another profile identifier, such as DirectionsProfileIdentifier.driving, this property is ignored in favor of the expected travel speed on each road along the route. This property may be supported by other routing profiles in the future.

    The value of this property must be at least CLLocationSpeed.minimumWalking and at most CLLocationSpeed.maximumWalking. The default value is CLLocationSpeed.normalWalking.

    Declaration

    Swift

    open var speed: LocationSpeed