navigation-ux-dash-config/com.mapbox.dash.sdk.config.api/DashConfig/Update

Update

class Update(config: DashConfig) : ConfigUpdate<DashConfig>

Defines configuration options available to be updated in the runtime. See Dash.applyUpdate.

Constructors

Update

constructor(config: DashConfig)

Properties

destinationPreviewConfig

var destinationPreviewConfig: DashDestinationPreviewConfig.Update?

Configure DestinationPreview.

logLevel

var logLevel: Int?

One of LogsExtra levels to define the logs that should be produced by Dash SDK.

mapGptConfig

var mapGptConfig: DashMapGptConfig.Update?

Configures the Mapbox MapGPT feature used within Dash.

mapStyleConfig

var mapStyleConfig: DashMapStyleConfig.Update?

Configures the Mapbox Maps styles used with Dash.

preferLocalTts

var preferLocalTts: Boolean?

Configures the TTS engine: local or remote.

routeOptionsConfig

var routeOptionsConfig: DashRouteOptionsConfig.Update?

Configure route options.

searchConfig

var searchConfig: DashSearchConfig.Update?

Configure search

speedLimitsOptionsConfig

var speedLimitsOptionsConfig: DashSpeedLimitsOptionsConfig.Update?

Configure speed limits options.

themeConfig

var themeConfig: DashThemeConfig.Update?

Configures appearance of Dash's UI elements.

uiConfig

var uiConfig: DashUiConfig.Update?

Configures UI

uiSettingsConfig

var uiSettingsConfig: DashUiSettingsConfig.Update?

Configure settings screen

unitOfMeasurement

var unitOfMeasurement: String?

Configures default unit of measurement.

weatherConfig

var weatherConfig: DashWeatherConfig.Update?

Configure weather

Functions

applyUpdateTo

open override fun applyUpdateTo(config: DashConfig): DashConfig

Create base config class with the update applied.

destinationPreviewConfig

fun destinationPreviewConfig(func: DashDestinationPreviewConfig.Update.() -> Unit): DashConfig.Update

Configure UI Settings setup.

mapGptConfig

fun mapGptConfig(func: DashMapGptConfig.Update.() -> Unit): DashConfig.Update

Configures the Mapbox MapGPT feature used within Dash.

mapStyleConfig

fun mapStyleConfig(func: DashMapStyleConfig.Update.() -> Unit): DashConfig.Update

Configures the Mapbox Maps styles used with Dash.

routeOptionsConfig

fun routeOptionsConfig(func: DashRouteOptionsConfig.Update.() -> Unit): DashConfig.Update

Configure route options.

searchConfig

fun searchConfig(func: DashSearchConfig.Update.() -> Unit): DashConfig.Update

Configure Search setup.

speedLimitsOptionsConfig

fun speedLimitsOptionsConfig(func: DashSpeedLimitsOptionsConfig.Update.() -> Unit): DashConfig.Update

themeConfig

fun themeConfig(func: DashThemeConfig.Update.() -> Unit): DashConfig.Update

Configures appearance of Dash's UI elements.

uiConfig

fun uiConfig(func: DashUiConfig.Update.() -> Unit): DashConfig.Update

Configure UI setup.

uiSettingsConfig

fun uiSettingsConfig(func: DashUiSettingsConfig.Update.() -> Unit): DashConfig.Update

Configure UI Settings setup.

weatherConfig

fun weatherConfig(func: DashWeatherConfig.Update.() -> Unit): DashConfig.Update

Configure Weather setup.