mapbox-directions-swift

Changes since v2.3.0-rc.1:

• Added RouteLeg.viaWaypoints property and SilentWaypoint struct for describing silent waypoints along RouteLeg. (#656)

Documentation is available online or within Xcode.

No changes since v2.3.0-beta.2.

Documentation is available online or within Xcode.

Changes since v2.2.0:

• Added VisualInstruction.Component.ShieldRepresentation struct for displaying a highway shield. Added VisualInstruction.Component.ImageRepresentation.shield property. (#644, #647)

Documentation is available online or within Xcode.

Changes since v2.2.0:

• Added VisualInstruction.Component.ShieldRepresentation struct for displaying a highway shield. Renamed VisualInstruction.Component.image(image:alternativeText:) to VisualInstruction.Component.image(image:alternativeText:shield:). (#644)

Documentation is available online or within Xcode.

Changes since v2.1.0:

• Added the RouteResponse.roadClassViolations property, which indicates any requested RouteOptions.roadClassesToAvoid values that could not be satisfied when calculating the routes. You can use convenience RouteResponse.exclusionViolations(routeIndex:legIndex:stepIndex:intersectionIndex:) method to search for a specific item. (#627)
• Fixed an issue where PolyLineString encoded an invalid GeoJSON LineString. (#638)
• Added RouteRefreshSource protocol to allow refreshing Route objects with RefreshedRoute or another Route instance. (#634)

Documentation is available online or within Xcode.

Changes since v2.2.0-alpha.1:

• Fixed an issue where PolyLineString encoded an invalid GeoJSON LineString. (#638)
• Added RouteRefreshSource protocol to allow refreshing Route objects with RefreshedRoute or another Route instance. (#634)

Documentation is available online or within Xcode.

Changes since v2.1.0:

• Added the RouteResponse.roadClassViolations property, which indicates any requested RouteOptions.roadClassesToAvoid values that could not be satisfied when calculating the routes. You can use convenience RouteResponse.exclusionViolations(routeIndex:legIndex:stepIndex:intersectionIndex:) method to search for a specific item. (#627)

Documentation is available online or within Xcode.

Changes since v2.0.0:

• Added the Waypoint.snappedDistance property to get the straight-line distance from the waypoint to the location it was snapped to in the RouteResponse. (#616)
• Added the RouteOptions.initialManeuverAvoidanceRadius property to avoid a sudden maneuver when calculating a route while the user is in motion. (#609)
• Added the RoadClasses.unpaved option for avoiding unpaved roads. (#620)
• Added the RoadClasses.cashOnlyToll property for avoiding toll roads that only accept cash payment. (#620)
• Added Isochrones, which connects to the Mapbox Isochrone API to compute areas that are reachable within a specified amount of time from a location and return the reachable regions as contours of polygons or lines that you can display on a map. (#621)
• Renamed DirectionsCredentials and DirectionsProfileIdentifier to Credentials and ProfileIdentifier, respectively. (#621)
• Added the RouteOptions.maximumHeight and RouteOptions.maximumWidth properties for ensuring that the resulting routes can accommodate a vehicle of a certain size. (#623)
• The DirectionsPriority struct now conforms to the Codable protocol. (#623)
• Fixed an issue where the RouteOptions.alleyPriority, RouteOptions.walkwayPriority, and RouteOptions.speed properties were excluded from the encoded representation of a RouteOptions object. (#623)

Documentation is available online or within Xcode.

Changes since v2.1.0-alpha.1:

• Added Isochrones, which connects to the Mapbox Isochrone API to compute areas that are reachable within a specified amount of time from a location and return the reachable regions as contours of polygons or lines that you can display on a map. (#621)
• Renamed DirectionsCredentials and DirectionsProfileIdentifier to Credentials and ProfileIdentifier, respectively. (#621)
• Added the RouteOptions.maximumHeight and RouteOptions.maximumWidth properties for ensuring that the resulting routes can accommodate a vehicle of a certain size. (#623)
• The DirectionsPriority struct now conforms to the Codable protocol. (#623)
• Fixed an issue where the RouteOptions.alleyPriority, RouteOptions.walkwayPriority, and RouteOptions.speed properties were excluded from the encoded representation of a RouteOptions object. (#623)

Documentation is available online or within Xcode.

Changes since v2.0.0:

• Added the Waypoint.snappedDistance property to get the straight-line distance from the waypoint to the location it was snapped to in the RouteResponse. (#616)
• Added the RouteOptions.initialManeuverAvoidanceRadius property to avoid a sudden maneuver when calculating a route while the user is in motion. (#609)
• Added the RoadClasses.unpaved option for avoiding unpaved roads. (#620)
• Added the RoadClasses.cashOnlyToll property for avoiding toll roads that only accept cash payment. (#620)

Documentation is available online or within Xcode.

Changes since v1.0.0:

Packaging

• To gain access to the Mapbox Directions and Map Matching APIs, set MBXAccessToken in your Info.plist. MGLMapboxAccessToken is still supported but is now deprecated. (#522)
• MapboxDirections now requires Turf v2.x. (#571, #608)
• Carthage v0.38 or above is now required for installing this SDK if you use Carthage. (#548)
• Xcode 12.0 or above is now required to build MapboxDirections from source. (#548)
• You can fully build this SDK on Macs with Apple Silicon. (#548)
• The mapbox-directions-swift command line tool can no longer be built using Carthage. It now requires swift-argument-parser v1.0.0 or above. (#606)

Other changes

• The Incident.impact property is now an Incident.Impact value instead of a string. (#519)
• RouteOptions.alleyPriority, RouteOptions.walkwayPriority, and RouteOptions.speed are now optional. Set them explicitly if you want to include them in the HTTP request. Renamed DirectionsOptions.default to DirectionsOptions.medium. (#557)
• Removed the DirectionsResult.routeIdentifier property. Use the RouteResponse.identifier property in conjunction with an index into the RouteResponse.routes array instead. (#562)
• Added the Intersection.preferredApproachLanes and Intersection.usableLaneIndication properties that indicate preferred lane usage. VisualInstruction.Component.lane(indications:isUsable:) has been renamed to VisualInstruction.Component.lane(indications:isUsable:preferredDirection:). (#529)
• Comparing two Intersections with == now considers whether the Intersection.restStop, Intersection.regionCode, and Intersection.outletMapboxStreetsRoadClass properties are equal. (#529)
• Added the Waypoint.allowsSnappingToClosedRoad property to allow snapping the waypoint’s location to a closed part of a road. (#583)
• Added AttributeOptions.numericCongestionLevel, RouteLeg.segmentNumericCongestionLevels, RouteLeg.Attributes.segmentNumericCongestionLevels and NumericCongestionLevel to support receiving the numeric value for congestion level along each segment of a RouteLeg. (#575)
• Added a RouteOptions.roadClassesToAllow property that enables the resulting routes to use HOV-only roads or high-occupancy toll roads. (#598)
• Added new optional parameters to the Directions(credentials:urlSession:processingQueue:) initializer that allow you to provide a custom URLSession and GCD processing queue. (#613)
• Fixed an issue where RouteStep.exitIndex was always unset. (#567)
• Fixed an issue where RouteLeg.segmentRangesByStep contained a range that was off by one for the arrival step of a leg. (#587)

Documentation is available online or within Xcode.

Changes since v2.0.0-rc.3:

• MapboxDirections now requires Turf v2.x. (#571)
• The mapbox-directions-swift command line tool can no longer be built using Carthage. It now requires swift-argument-parser v1.0.0 or above. (#606)

Documentation is available online or within Xcode.

Changes since v2.0.0-rc.2:

• 🐞 Fixed an issue where coding keys for DirectionsOptions, RouteOptions, and MatchOptions don't match the query parameter names. (#593)

Documentation is available online or within Xcode.

Changes since v2.0.0-rc.1:

• Fixed an issue where RouteLeg.segmentRangesByStep contained a range that was off by one for the arrival step of a leg. (#587)

Documentation is available online or within Xcode.

Changes since v2.0.0-beta.9:

• Added option to snap Waypoints to closed parts of the roads. (#583)
• Added numeric congestion annotation data support (#575)
• Fixed appending service SKU token if it doesn't match the Access token (#588, #591)

Documentation is available online or within Xcode.

Changes since v2.0.0-beta.8:

• Fixed an issue where sku_token wasn’t appended to refresh route requests. (#579)

Documentation is available online or within Xcode.

Changes since v2.0.0-beta.7:

• This library requires Turf v2.0.0-rc.1. (#571)

Documentation is available online or within Xcode.

Changes since v2.0.0-beta.6:

• Removed the DirectionsResult.routeIdentifier property. Use the RouteResponse.identifier property in conjunction with an index into the RouteResponse.routes array instead. (#562)
• Fixed a bug where leg source and destination are mismatched when route contains trackpoint or silent waypoint. (#560)

Documentation is available online or within Xcode.

Changes since v2.0.0-beta.5:

• RouteOptions.alleyPriority, RouteOptions.walkwayPriority, and RouteOptions.speed are now optional. Set them explicitly if you want to include them in the HTTP request. Renamed DirectionsOptions.default to DirectionsOptions.medium. (#557)

Documentation is available online or within Xcode.

Changes since v2.0.0-beta.4:

• Carthage v0.38 or above is now required for installing this SDK if you use Carthage. #548
• Xcode 12.0 or above is now required to build MapboxDirections from source. #548
• You can fully build this SDK on Macs with Apple Silicon. #548

Documentation is available online or within Xcode.