mapbox-directions-swift

Changes since v2.0.0-beta.3:

• This library requires Turf v2.0.0-beta.1. (#545)

Documentation is available online or within Xcode.

Changes since v2.0.0-beta.2:

• Preferred lane direction is now of type ManeuverDirection. (#535)

Documentation is available online or within Xcode.

Changes since v2.0.0-beta.1:

• Fixed an issue where VisualInstruction.component.lane(indications:isUsable:preferredDirection:) failed to decode and encoded incorrectly. (#532)

Documentation is available online or within Xcode.

Changes since v2.0.0-alpha.2:

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

Documentation is available online or within Xcode.

Changes since v2.0.0-alpha.1:

• This library requires Turf v2.0.0-alpha.3. tvOS, watchOS, and Linux support was restored. (#525)
• MBXAccessToken is now used as default access token, in case if it's not found in Info.plist MGLMapboxAccessToken will be used. (#522)

Changes since v1.2.0:

• This library requires Turf v2.0.0-alpha.2. (#517)
• This library does not support tvOS, watchOS, or Linux. Support for these platforms will be restored before the final release. (#517)
• The Incident.impact property is now an Incident.Impact value instead of a string. (#519)

Documentation is available online or within Xcode.

Changes since v1.1.0:

Packaging

• Added support for building and running on any Linux distribution supported by Swift. (#488)
• Added the MapboxDirectionsCLI command line tool that round-trips Mapbox Directions API responses between JSON format and Swift model objects. (#469)

Other changes

• Added the RouteStep.segmentIndicesByIntersection property for associating Intersections with portions of the step’s shape. (#490)
• Added the Intersection.outletMapboxStreetsRoadClass property that indicates a more detailed road classification than the existing Intersection.outletRoadClasses property. (#507)
• Added the RouteLeg.incidents property that indicates known traffic incidents, toll collection points, rest areas, and border crossings along the route leg. (#466, #506)
• Added the RouteLeg.regionCode(atStepIndex:intersectionIndex:) method and Intersection.regionCode property to get the administrative region where an intersection is located, as well as a RouteLeg.administrativeRegions property that indicates the administrative regions traversed by the route leg. (#466, #485, #506)
• Added the Intersection.tunnelName, Intersection.tollCollection, Intersection.restStop, and Intersection.isUrban properties. (#466, #506)
• The CongestionLevel enumeration now conforms to the CaseIterable protocol. (#500)

Documentation is available online or within Xcode.

Changes since v1.2.0-alpha.3:

• Fixed an issue where JSONEncoder did not encode the Intersection.tollCollection property. (#510)

Documentation is available online or within Xcode.

Changes since v1.2.0-alpha.2:

• Added the Intersection.outletMapboxStreetsRoadClass property that indicates a more detailed road classification than the existing Intersection.outletRoadClasses property. (#507)
• Added the RouteLeg.incidents property that indicates known traffic incidents, toll collection points, rest areas, and border crossings along the route leg. (#466, #506)
• Added the RouteLeg.administrativeRegions property that indicates the administrative regions traversed by the route leg. (#466, #506)
• Added the Intersection.tunnelName, Intersection.tollCollection, Intersection.restStop, and Intersection.isUrban properties. (#466, #506)

Documentation is available online or within Xcode.

Changes since v1.2.0-alpha.1:

• The CongestionLevel enumeration now conforms to the CaseIterable protocol. (#500)
• Refined encoding/decoding logic for AdministrativeRegions by Leg and Intersection (#485). Added few properties for convenience access:
  • Intersection.regionCode - A 2-letter region code to identify corresponding country that this intersection lies in.
  • RouteLeg.regionCode(atStepIndex:, intersectionIndex:) - Returns the ISO 3166-1 alpha-2 region code for the administrative region through which the given intersection passes.
• Added RouteStep.segmentIndicesByIntersection for navigating Intersections segments along the step; (#490)

Changes since v1.1.0:

• Added support for building and running on any Linux distribution supported by Swift. (#488)
• Added the MapboxDirectionsCLI command line tool that round-trips Mapbox Directions API responses between JSON format and Swift model objects. (#469)

Changes since v1.0.0:

• Added the DirectionsResult.typicalTravelTime, RouteLeg.typicalTravelTime and RouteStep.typicalTravelTime properties that indicate the typical travel time, as opposed to the current expected travel time. (#462)
• Fixed an error that occurred when setting the Waypoint.separatesLegs property to true and setting the Waypoint.targetCoordinate property. (#480)
• Directions.fetchAvailableOfflineVersions(completionHandler:) now calls its completion handler on the main queue consistently. (#475)
• Upgraded to Polyline v5.0.0. (#487)

Documentation is available online or within Xcode.

Changes since v1.0.0:

• Added the DirectionsResult.typicalTravelTime, RouteLeg.typicalTravelTime and RouteStep.typicalTravelTime properties that indicate the typical travel time, as opposed to the current expected travel time. (#462)
• Fixed an error that occurred when setting the Waypoint.separatesLegs property to true and setting the Waypoint.targetCoordinate property. (#480)
• Directions.fetchAvailableOfflineVersions(completionHandler:) now calls its completion handler on the main queue consistently. (#475)
• Upgraded to Polyline v5.0.0. (#487)

Changes since v0.33.2:

• Added the Directions.refreshRoute(responseIdentifier:routeIndex:fromLegAtIndex:completionHandler:) method for refreshing attributes along the legs of a route and the Route.refreshLegAttributes(from:) method for merging the refreshed attributes into an existing route. To enable route refreshing for the routes in a particular route response, set RouteOptions.refreshingEnabled to true before passing the RouteOptions object into Directions.calculate(_:completionHandler:). (#420)
• Fixed a crash that could occur if the Mapbox Directions API includes unrecognized RoadClasses values in its response. (#450)
• Fixed malformed RouteStep.shape values that could occur when RouteStep.maneuverType is ManeuverType.arrive, DirectionsOptions.shapeFormat is RouteShapeFormat.polyline6, and the Mapbox Directions API returns certain encoded Polyline strings. (#456)
• Restored the DirectionsOptions.urlQueryItems property so that subclasses of RouteOptions and MatchOptions can add any additional URL query parameters that are supported by the Mapbox Directions and Map Matching APIs. (#461)

Documentation is available online or within Xcode.

Changes since v1.0.0-rc.1:

• Fixed malformed RouteStep.shape values that could occur when RouteStep.maneuverType is ManeuverType.arrive, DirectionsOptions.shapeFormat is RouteShapeFormat.polyline6, and the Mapbox Directions API returns certain encoded Polyline strings. (#456)

Documentation is available online or within Xcode.

Changes since v0.33.2:

• Added the Directions.refreshRoute(responseIdentifier:routeIndex:fromLegAtIndex:completionHandler:) method for refreshing attributes along the legs of a route and the Route.refreshLegAttributes(from:) method for merging the refreshed attributes into an existing route. To enable route refreshing for the routes in a particular route response, set RouteOptions.refreshingEnabled to true before passing the RouteOptions object into Directions.calculate(_:completionHandler:). (#420)
• Fixed a crash that could occur if the Mapbox Directions API includes unrecognized RoadClasses values in its response. (#450)

Documentation is available online or within Xcode.

Changes since v0.33.1:

• Fixed an issue where waypoints in a RouteResponse did not persist the Waypoint.targetCoordinate, Waypoint.heading, Waypoint.headingAccuracy, and Waypoint.allowsArrivingOnOppositeSide properties from the initial RouteOptions object. (#446)

Documentation is available online or within Xcode.

Changes since v0.33.0:

• Fixed an issue where RouteResponse(matching:options:credentials:) and Directions.calculateRoutes(matching:completionHandler:) resulted in misshappen Route.shapes and RouteStep.shapes in the Atlantic Ocean if MatchOptions.shapeFormat was set to RouteShapeFormat.polyline6. (#437)

Documentation is available online or within Xcode.

Changes since v0.31.0:

• Fixed an issue where RouteResponse(matching:options:credentials:) and Directions.calculateRoutes(matching:completionHandler:) resulted in misshappen Route.shapes and RouteStep.shapes in the Atlantic Ocean if MatchOptions.shapeFormat was set to RouteShapeFormat.polyline6. (#437)

Documentation is available online or within Xcode.

Changes since v0.32.0:

• Fixed an issue where decoding and reencoding a JSON-formatted response from the Mapbox Directions API would cause the voiceLocale property to be omitted from route objects. (#424)
• Added the Route(legs:shape:distance:expectedTravelTime:) and Route(from:) initializers. (#430)
• Fixed an issue where VisualInstruction.Component.guidanceView lacked an image URL. (#432)

Documentation is available online or within Xcode.