NavigationMapView

A collection of street road classes for which a congestion level substitution should occur.

For any street road class included in the roadClassesWithOverriddenCongestionLevels, all route segments with an CongestionLevel.unknown traffic congestion level and a matching MapboxDirections.MapboxStreetsRoadClass. will be replaced with the CongestionLevel.low congestion level.

Controls whether to show congestion levels on alternative route lines. Defaults to false.

If true and there’re multiple routes to choose, the alternative route lines would display the congestion levels at different colors, similar to the main route. To customize the congestion colors that represent different congestion levels, override the alternativeTrafficUnknownColor, alternativeTrafficLowColor, alternativeTrafficModerateColor, alternativeTrafficHeavyColor, alternativeTrafficSevereColor property for the NavigationMapView.appearance().

Controls wheter to show restricted portions of a route line.

Restricted areas are drawn using routeRestrictedAreaColor which is customizable.

The tolerance value used for configuring the underlying map source of route line, maneuver arrow and restricted areas.

Controls the level of simplification by specifying the maximum allowed distance between the original line point and the simplified point. A higher tolerance value results in higher simplification and faster performance. Changing the property will affect only newly added sources.

Controls whether to show fading gradient color on route lines between two different congestion level segments. Defaults to false.

If true, the congestion level change between two segments in the route line will be shown as fading gradient color instead of abrupt and steep change.

Controls whether the main route style layer and its casing disappears as the user location puck travels over it. Defaults to false.

Used in standalone NavigationMapView during active navigation. If using NavigationViewController and CarPlayNavigationViewController for active navigation, update NavigationViewController.routeLineTracksTraversal and CarPlayNavigationViewController.routeLineTracksTraversal instead.

If true, the part of the route that has been traversed will be rendered with full transparency, to give the illusion of a disappearing route. To customize the color that appears on the traversed section of a route, override the traversedRouteColor property for the NavigationMapView.appearance(). If false, the whole route will be shown without traversed part disappearing effect.

To update the route line during active navigation when RouteProgress changes, add observer for Notification.Name.routeControllerProgressDidChange and call NavigationMapView.updateRouteLine(routeProgress:coordinate:shouldRedraw:) with shouldRedraw as false.

To update the route line during active navigation when route refresh or rerouting happens, add observers for Notification.Name.routeControllerDidRefreshRoute and Notification.Name.routeControllerDidReroute. And call NavigationMapView.updateRouteLine(routeProgress:coordinate:shouldRedraw:) with shouldRedraw as true.

Maximum distance (in screen points) the user can tap for a selection to be valid when selecting an alternate route.

Gesture recognizer, that is used to detect taps on waypoints and routes that are currently present on the map. Enabled by default.

Visualizes the given routes and their waypoints and zooms the map to fit, removing any existing routes and waypoints from the map.

Each route is visualized as a line. Each line is color-coded by traffic congestion, if congestion levels are present and NavigationMapView.crossfadesCongestionSegments is set to true.

Waypoints along the route are visualized as markers. Implement NavigationMapViewDelegate methods to customize the appearance of the lines and markers representing the routes and waypoints.

To only visualize the routes and not the waypoints, or to have more control over the camera, use the show(_:legIndex:) method.

Visualizes the given routes, removing any existing routes from the map.

Each route is visualized as a line. Each line is color-coded by traffic congestion, if congestion levels are present. Implement NavigationMapViewDelegate methods to customize the appearance of the lines representing the routes. To also visualize waypoints and zoom the map to fit, use the showcase(_:animated:) method.

To undo the effects of this method, use the removeRoutes() method.

Remove any lines visualizing routes from the map.

This method undoes the effects of the show(_:legIndex:) method.

Shows the step arrow given the current RouteProgress.

Removes the RouteStep arrow from the MapView.

Color of the buildings, which were found at specific coordinates by calling NavigationMapView.highlightBuildings(at:in3D:extrudeAll:completion:) and when extrudeAll parameter is set to false.

Color of all other buildings, which will be highlighted after calling NavigationMapView.highlightBuildings(at:in3D:extrudeAll:completion:) and when extrudeAll parameter is set to true.

Specifies how the map displays the user’s current location, including the appearance and underlying implementation.

By default, this property is set to UserLocationStyle.puck2D(configuration:), the bearing source is location course.

Allows to control current user location styling based on accuracy authorization permission on iOS 14 and above.

If false, user location will be drawn based on style, which was set in NavigationMapView.userLocationStyle. If true, UserHaloCourseView will be shown.

Updates UserLocationStyle to provided location.

List of Mapbox Maps font names to be used for any symbol layers added by the Navigation SDK. These are used for features such as Route Duration Annotations that are optionally added during route preview. See https://docs.mapbox.com/ios/maps/api/6.3.0/customizing-fonts.html for more information about server-side fonts.

Shows a callout containing the duration of each route. Useful as a way to give the user more information when picking between multiple route alternatives. If the route contains any tolled segments then the callout will specify that as well.

Removes all visible route duration callouts.

Adds the route waypoints to the map given the current leg index. Previous waypoints for completed legs will be omitted.

Removes all existing Waypoint objects from MapView, which were added by NavigationMapView.

PointAnnotationManager, which is used to manage addition and removal of final destination annotation. PointAnnotationManager will become valid only after fully loading MapView style.

MapView, which is added on top of NavigationMapView and allows to render navigation related components.

The object that acts as the navigation delegate of the map view.

Attempts to localize labels into the system’s preferred language.

This method automatically modifies the SymbolLayer.textField property of any symbol style layer whose source is the Mapbox Streets source. The user can set the system’s preferred language in Settings, General Settings, Language & Region.

This method avoids localizing road labels into the system’s preferred language, in an effort to match road signage and the turn banner, which always display road names and exit destinations in the local language. If this NavigationMapView stands alone outside a NavigationViewController, you should call the MapboxMap.onEvery(_:handler:) on mapView, passing in MapEvents.EventKind.styleLoaded, and call this method inside the closure. The map view embedded in NavigationViewController is localized automatically, so you do not need to call this method on the value of NavigationViewController.navigationMapView.

Shows voice instructions for specific Route object.

Initializes a newly allocated NavigationMapView object with the specified frame rectangle.

Initializes a newly allocated NavigationMapView object with the specified frame rectangle and type of NavigationCamera.

Returns a NavigationMapView object initialized from data in a given unarchiver.

Returns a list of waypoints, that are located on the routes with more than one leg and are close to a certain point and are within threshold distance defined in NavigationMapView.tapGestureDistanceThreshold.

Returns a list of the routes, that are close to a certain point and are within threshold distance defined in NavigationMapView.tapGestureDistanceThreshold.

A TileStore instance used by map view.

Setups the Predictive Caching mechanism using provided Options.

This will handle all the required manipulations to enable the feature and maintain it during the navigations. Once enabled, it will be present as long as NavigationMapView is retained.

The minimum preferred frames per second at which to render map animations.

This property takes effect when the application has limited resources for animation, such as when the device is running on battery power. By default, this property is set to PreferredFPS.normal.

NavigationCamera, which allows to control camera states.

Updates the map view’s preferred frames per second to the appropriate value for the current route progress.

This method accounts for the proximity to a maneuver and the current power source. It has no effect if NavigationCamera is in NavigationCameraState.following state.

Receives coordinates for searching the map for buildings. If buildings are found, they will be highlighted in 2D or 3D depending on the in3D value.

Removes the highlight from all buildings highlighted by highlightBuildings(at:in3D:completion:).

Visualizes the given alternative routes, removing any existing from the map.

Each route is visualized as a line. Each route is displayed as a separate line as an inactive route, drawn from it’s deviation point and below the main route line.

To undo the effects of this method, use the removeContinuousAlternativesRoutes() method.

Remove any lines visualizing continuous alternatives routes from the map.

This method undoes the effects of the show(continuousAlternatives:) method.

Returns a list of the AlternativeRoutes, that are close to a certain point and are within threshold distance defined in NavigationMapView.tapGestureDistanceThreshold.

Update the existing primary route line during active navigation.

Find and cache the index of the upcoming [RouteLineDistancesIndex].

Updates the route style layer and its casing style layer to gradually disappear as the user location puck travels along the displayed route.