NavigationMapView

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 MGLMapViewPreferredFramesPerSecond.lowPower.

Returns the altitude that the map camera initally defaults to.

Returns the altitude the map conditionally zooms out to when user is on a motorway, and the maneuver length is sufficently long.

Returns the threshold for what the map considers a “long-enough” maneuver distance to trigger a zoom-out when the user enters a motorway.

Maximum distance the user can tap for a selection to be valid when selecting an alternate route.

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.

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

The object that acts as the course tracking delegate of the map view.

Determines whether the map should follow the user location and rotate when the course changes.

A type that represents a UIView that is CourseUpdatable.

A UserCourseView used to indicate the user’s location and course on the map.

The UserCourseView‘s UserCourseView.update(location:pitch:direction:animated:) method is frequently called to ensure that its visual appearance matches the map’s camera.

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 tracksUserCourse is set to true.

Track position on a frame by frame basis. Used for first location update and when resuming tracking mode

Showcases route array. Adds routes and waypoints to map, and sets camera to point encompassing the route.

Adds or updates both the route line and the route line casing.

This method will be called multiple times: • When the route preview map is shown, rendering alternative routes if necessary. • When the navigation session starts, rendering only the single route line.

Removes route line and route line casing from map

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

Removes all waypoints from the map.

Shows the step arrow given the current RouteProgress.

Removes the step arrow from the map.

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.

Attempts to localize road labels into the local language and other labels into the system’s preferred language.

When this property is enabled, the style automatically modifies the text property of any symbol style layer whose source is the Mapbox Streets source. On iOS, the user can set the system’s preferred language in Settings, General Settings, Language & Region.

Unlike the MGLStyle.localizeLabels(into:) method, this method localizes road labels into the local language, regardless of the system’s preferred language, in an effort to match road signage. The turn banner always displays road names and exit destinations in the local language, so you should call this method in the MGLMapViewDelegate.mapView(_:didFinishLoading:) method of any delegate of a standalone NavigationMapView. The map view embedded in NavigationViewController is localized automatically, so you do not need to call this method on the value of NavigationViewController.mapView.

Sets the camera directly over a series of coordinates.

Recenters the camera and begins tracking the user’s location.

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:).

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.