NavigationSettings

public class NavigationSettings

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

directions
Default Directions instance. By default, Directions.shared is used.

You can override this property by using NavigationSettings.initialize(directions:tileStoreConfiguration:routingProviderSource:) method.
Declaration
Swift

public var directions: Directions { get }
View Source on GitHub
tileStoreConfiguration
Global TileStoreConfiguration instance.

You can override this property by using NavigationSettings.initialize(directions:tileStoreConfiguration:routingProviderSource:) method.
Declaration
Swift

public var tileStoreConfiguration: TileStoreConfiguration { get }
View Source on GitHub
routingProviderSource
Default routingProviderSource used for rerouting during navigation. By default, .hybrid is used. You can override this property by using NavigationSettings.initialize(directions:tileStoreConfiguration:routingProviderSource:) method.
Declaration
Swift

public var routingProviderSource: RoutingProviderSource { get }
View Source on GitHub


                    
                    
                    initialize(directions:tileStoreConfiguration:routingProviderSource:)

Initializes the settings with custom instances of globally used types.

If you don’t provide custom values, they will be initialized with the defaults.

Important

If you want to use this method, it should be the first method you use from Navigation SDK. Not doing so will lead to undefined behavior.

routingProviderSource: Configures the type of routing to be used by various SDK objects when providing route calculations. Use this value to configure usage of onlive vs. offline data for routing.

Declaration

Swift

public func initialize(directions: Directions,
                       tileStoreConfiguration: TileStoreConfiguration,
                       routingProviderSource: RoutingProviderSource = .hybrid)

Parameters

`directions`	Default `Directions` instance. Some types allow you to customize the directions instance and fall back to the `NavigationSettings.directions` by default.
`tileStoreConfiguration`	Options for configuring how map and navigation tiles are stored on the device. See `TileStoreConfiguration` for more details.

View Source on GitHub

voiceVolume
The volume that the voice controller will use.

This volume is relative to the system’s volume where 1.0 is same volume as the system.
Declaration
Swift

public dynamic var voiceVolume: Float { get set }
View Source on GitHub
voiceMuted
Specifies whether to mute the voice controller or not.
Declaration
Swift

public dynamic var voiceMuted: Bool { get set }
View Source on GitHub
distanceUnit
Specifies the preferred distance measurement unit. Meters and feet will be used when the presented distances are small enough. See DistanceFormatter for more information.
Declaration
Swift

public dynamic var distanceUnit: LengthFormatter.Unit { get set }
View Source on GitHub
shared
The shared navigation settings object that affects the entire application.
Declaration
Swift

public static let shared: NavigationSettings
View Source on GitHub