NavigationOptions

class NavigationOptions

This value will be used to offset the time at which the current location was calculated in such a way as to project the location forward along the current trajectory so as to appear more in sync with the users ground-truth location

Parameters

applicationContext

the Context of the Android Application

accessToken

Mapbox Access Token

locationEngine

the mechanism responsible for providing location approximations to navigation

locationEngineRequest

specifies the rate to request locations from the location engine.

timeFormatType

defines time format for calculation remaining trip time

navigatorPredictionMillis

defines approximate navigator prediction in milliseconds

distanceFormatter

DistanceFormatter for format distances showing in notification during navigation

onboardRouterOptions

OnboardRouterOptions defines configuration for the default on-board router

isFromNavigationUi

Boolean true if is called from UI, otherwise false

isDebugLoggingEnabled

Boolean

deviceProfile

DeviceProfile defines how navigation data should be interpretation

eHorizonOptions

EHorizonOptions defines configuration for the Electronic Horizon

isRouteRefreshEnabled

Boolean true if need to enable route refresh mechanism, otherwise false

Types

Builder

class Builder(applicationContext: Context)

Build a new NavigationOptions

Functions

equals

open operator override fun equals(other: Any?): Boolean

Regenerate whenever a change is made

hashCode

open override fun hashCode(): Int

Regenerate whenever a change is made

toBuilder

fun toBuilder(): NavigationOptions.Builder

Get a builder to customize a subset of current options.

toString

open override fun toString(): String

Returns a string representation of the object.

Properties

accessToken

val accessToken: String?

Mapbox Access Token

applicationContext

val applicationContext: Context

the Context of the Android Application

deviceProfile

val deviceProfile: DeviceProfile

DeviceProfile defines how navigation data should be interpretation

distanceFormatter

val distanceFormatter: DistanceFormatter?

DistanceFormatter for format distances showing in notification during navigation

eHorizonOptions

val eHorizonOptions: EHorizonOptions

EHorizonOptions defines configuration for the Electronic Horizon

isDebugLoggingEnabled

val isDebugLoggingEnabled: Boolean

Boolean

isFromNavigationUi

val isFromNavigationUi: Boolean

Boolean true if is called from UI, otherwise false

isRouteRefreshEnabled

val isRouteRefreshEnabled: Boolean

Boolean true if need to enable route refresh mechanism, otherwise false

locationEngine

val locationEngine: LocationEngine

the mechanism responsible for providing location approximations to navigation

locationEngineRequest

val locationEngineRequest: LocationEngineRequest