v2.3.0

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.

v2.3.0-rc.2

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.

v2.3.0-rc.1

No changes since v2.3.0-beta.2.

Documentation is available online or within Xcode.

v2.3.0-beta.2

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.

v2.3.0-beta.1

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.

v2.2.0

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.

v2.2.0-rc.1

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.

v2.2.0-alpha.1

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.

v2.1.0

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.

v2.1.0-rc.1

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.