mapbox-directions-swift

No changes since v2.5.0-beta.1.

Documentation is available online or within Xcode.

Changes since v2.4.0:

• Added the RestStop.name property. (#689)
• Added the TollCollection.name property. (#691)
• Types that correspond to objects in the Mapbox Directions API response, such as RouteResponse, RouteRefreshResponse, MatchResponse, and RouteStep, now conform to the ForeignMemberContainer and ForeignMemberClassContainer protocols. Types that conform to these protocols can persist unrecognized properties in the response, such as properties that are in beta, even after coding and decoding. You can access these properties using the ForeignMemberContainer.foreignMembers and ForeignMemberClassContainer.foreignMembers properties. (#669)
• Fixed an issue where decoding a RouteResponse incorrectly set the Waypoint.snappedDistance property to nil. (#669)
• The mapbox-directions-swift command line tool now requests routes from the Mapbox Directions API if no input file is specified. (#576)

Documentation is available online or within Xcode.

Changes since v2.3.0:

• Fixed a crash that occurred when RouteOptions.roadClassesToAvoid or RouteOptions.roadClassesToAllow properties contained multiple road classes.
• RoadClasses.tunnel and RoadClasses.restricted are no longer supported in RouteOptions.roadClassesToAvoid or RouteOptions.roadClassesToAllow properties
• Added DirectionsOptions(url:), RouteOptions(url:) and extended existing DirectionsOptions(waypoints:profileIdentifier:queryItems:), RouteOptions(waypoints:profileIdentifier:queryItems:), MatchOptions(waypoints:profileIdentifier:queryItems:) and related convenience init methods for deserializing corresponding options object using appropriate request URL or it's query items. (#655)
• Added Incident properties: countryCode, countryCodeAlpha3, roadIsClosed, longDescription, numberOfBlockedLanes, congestionLevel, affectedRoadNames. (#672)
• Added departAt and arriveBy properties to RouteOptions to allow configuring Directions routes calculation. (#673)
• Removed url request's .json suffix for Directions and Isochrones to follow V5 scheme. (#678)

Documentation is available online or within Xcode.

Changes since v2.4.0-rc.1:

• Added Incident properties: countryCode, countryCodeAlpha3, roadIsClosed, longDescription, numberOfBlockedLanes, congestionLevel, affectedRoadNames. (#672)
• Added departAt and arriveBy properties to RouteOptions to allow configuring Directions routes calculation. (#673)

Documentation is available online or within Xcode.

No changes since v2.4.0-beta.1.

Documentation is available online or within Xcode.

Changes since v2.3.0:

• Fixed a crash that occurred when RouteOptions.roadClassesToAvoid or RouteOptions.roadClassesToAllow properties contained multiple road classes. (#664)
• RoadClasses.tunnel and RoadClasses.restricted are no longer supported in RouteOptions.roadClassesToAvoid or RouteOptions.roadClassesToAllow properties (#664)
• Added DirectionsOptions(url:), RouteOptions(url:) and extended existing DirectionsOptions(waypoints:profileIdentifier:queryItems:), RouteOptions(waypoints:profileIdentifier:queryItems:), MatchOptions(waypoints:profileIdentifier:queryItems:) and related convenience init methods for deserializing corresponding options object using appropriate request URL or it's query items. (#655)

Documentation is available online or within Xcode.

Changes since v2.2.0:

• Added VisualInstruction.Component.ShieldRepresentation struct and the VisualInstruction.Component.ImageRepresentation.shield property containing metadata for displaying a highway shield consistent with map styles used by the Mapbox Maps SDK. (#644, #647)
• Added a RouteLeg.viaWaypoints property that lists the non-leg-separating waypoints (also known as “silent waypoints”) along a RouteLeg. Previously, you had to filter DirectionsOptions.waypoints to include only the items whose Waypoints.separatesLegs property was set to true, then zip them with RouteResponse.routes. This approach still works in some cases but is not guaranteed to be reliable for all Mapbox Directions API responses in the future. (#656)

Documentation is available online or within Xcode.

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.