Configuration

When calculating whether or not the user is on the route, we look where the user will be given their speed and this variable.

public var RouteControllerDeadReckoningTimeInterval: TimeInterval

Maximum number of meters the user can travel away from step before RouteControllerShouldReroute is emitted.

public var RouteControllerMaximumDistanceBeforeRecalculating: CLLocationDistance

Given a location update, the horizontalAccuracy is used to figure out how many consective location updates to wait before rerouting due to consecutive incorrect course updates.

public var RouteControllerIncorrectCourseMultiplier: Int

Minimum number of consecutive incorrect course updates before rerouting occurs.

public var RouteControllerMinNumberOfInCorrectCourses: Int

The minimum distance in the opposite direction of travel that triggers rerouting.

public var RouteControllerMinimumBacktrackingDistanceForRerouting: CLLocationDistance

Minimum duration remaining in seconds for proactive rerouting to be active.

public var RouteControllerMinimumDurationRemainingForProactiveRerouting: TimeInterval

Minimum number of consecutive location updates moving backwards before the user is rerouted.

public var RouteControllerMinimumNumberLocationUpdatesBackwards: Int

Number of seconds reroute feedback sections are shown in the feedback view after the user is rerouted.

public var RouteControllerNumberOfSecondsForRerouteFeedback: TimeInterval

The number of seconds between attempts to automatically calculate a more optimal route while traveling.

In addition to calculating a more optimal route, RouteController also refreshes time-dependent statistics about the route, such as traffic congestion and the remaining duration, as long as DirectionsOptions.profileIdentifier is set to DirectionsProfileIdentifier.automobileAvoidingTraffic and RouteOptions.refreshingEnabled is set to true.

public var RouteControllerProactiveReroutingInterval: TimeInterval

Number of seconds left on step when a AlertLevel.medium alert is emitted.

public var RouteControllerMediumAlertInterval: TimeInterval

Number of seconds left on step when a AlertLevel.high alert is emitted.

public var RouteControllerHighAlertInterval: TimeInterval

For shorter upcoming steps, we link the AlertLevel.high instruction. If the upcoming step duration is near the duration of RouteControllerHighAlertInterval, we need to apply a bit of a buffer to prevent back to back notifications.

A multiplier of 1.2 gives us a buffer of 3 seconds, enough time insert a new instruction.

public let RouteControllerLinkedInstructionBufferMultiplier: Double

The minimum distance threshold used for giving a “Continue” type instructions.

public var RouteControllerMinimumDistanceForContinueInstruction: CLLocationDistance

Radius in meters the user must enter to count as completing a step. One of two heuristics used to know when a user completes a step, see RouteControllerMaximumAllowedDegreeOffsetForTurnCompletion.

public var RouteControllerManeuverZoneRadius: CLLocationDistance

Threshold user must be in within to count as completing a step. One of two heuristics used to know when a user completes a step, see RouteControllerManeuverZoneRadius.

The users heading and the finalHeading are compared. If this number is within RouteControllerMaximumAllowedDegreeOffsetForTurnCompletion, the user has completed the step.

public var RouteControllerMaximumAllowedDegreeOffsetForTurnCompletion: Double

Maximum angle the user puck will be rotated when snapping the user’s course to the route line.

public var RouteSnappingMaxManipulatedCourseAngle: CLLocationDirection

Accepted deviation excluding horizontal accuracy before the user is considered to be off route.

public var RouteControllerUserLocationSnappingDistance: CLLocationDistance

The position of speed limit view and floating buttons, including the overview, mute and feedback report in a navigation view.

See more

public enum MapOrnamentPosition

Attribute name for the route line that is used for identifying different CongestionLevel along the route.

public let CongestionAttribute: String

Attribute name for the route line that is used for identifying whether a RouteLeg is the current active leg.

public let CurrentLegAttribute: String

A stop dictionary representing the default line widths of the route line by zoom level when NavigationMapViewDelegate.navigationMapView(_:routeLineLayerWithIdentifier:sourceIdentifier:) is undefined.

You may use this constant in your implementation of NavigationMapViewDelegate.navigationMapView(_:routeLineLayerWithIdentifier:sourceIdentifier:) if you want to keep the default line widths but customize other aspects of the route line.

public var RouteLineWidthByZoomLevel: [Double : Double]

The minimum distance remaining on a route before overhead zooming is stopped.

@available(*, deprecated, message: "This value is no longer used.")
public var NavigationMapViewMinimumDistanceForOverheadZooming: CLLocationDistance

The minimum volume for the device before a gentle warning is emitted when beginning navigation.

public let NavigationViewMinimumVolumeForWarning: Float

The distance of fading color change between two different congestion level segments in meters.

public var GradientCongestionFadingDistance: CLLocationDistance

When calculating the user’s snapped location, this constant will be used for deciding upon which step coordinates to include in the calculation.

public var RouteControllerMaximumSpeedForUsingCurrentStep: CLLocationSpeed

Minimum Accuracy (maximum deviation, in meters) that the route snapping engine will accept before it stops snapping.

public var RouteSnappingMinimumHorizontalAccuracy: CLLocationAccuracy

The minimum speed value before the user’s actual location can be considered over the snapped location.

public var RouteSnappingMinimumSpeed: CLLocationSpeed

Global settings that are used across the SDK for altering navigation behavior.

Some properties listed in StoredProperty are stored in UserDefaults.standard.

To specify criteria when calculating routes, use the NavigationRouteOptions class.

To customize the user experience during a particular turn-by-turn navigation session, use the NavigationOptions class when initializing a NavigationViewController.

To customize some global defaults use NavigationSettings.initialize(directions:tileStoreConfiguration:routingProviderSource:alternativeRouteDetectionStrategy:utilizeSensorData:navigatorPredictionInterval:liveIncidentsOptions:) method.

See more

public class NavigationSettings