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

Builder

class Builder(val applicationContext: Context, val accessToken: String) : DashConfigBuilder<DashConfig, DashConfig.Builder>

Creates a new instance of DashConfig.

Parameters

applicationContext

context of the application.

accessToken

access token from your Mapbox account. You can create a new one in your Mapbox Account.

Constructors

Link copied to clipboard
constructor(applicationContext: Context, accessToken: String)

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
var cameraConfig: DashCameraConfig

Configures camera.

Link copied to clipboard
open var customValues: MutableMap<String, Any>

Map of custom configuration key -> value pairs.

Link copied to clipboard
var destinationPreviewConfig: DashDestinationPreviewConfig

Configures DestinationPreview.

Link copied to clipboard
var device: DashDeviceType

DashDeviceType that defines the type of device on which the app is running. The type of device providing data to the navigator.

Link copied to clipboard
var engineType: String?

Configures vehicle's engine type.

Link copied to clipboard
var locale: Locale

Locale that should be used for guidance instruction and other localization features.

Link copied to clipboard
var locationSimConfig: DashLocationSimConfig

Configures location simulation.

Link copied to clipboard
var logLevel: Int

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

Link copied to clipboard
var mapGptConfig: DashMapGptConfig

Configures the Mapbox MapGPT feature used within Dash.

Link copied to clipboard
var mapStyleConfig: DashMapStyleConfig

Configures the Mapbox Maps styles used with Dash. You can edit or create new ones via Mapbox Studio.

Link copied to clipboard
var preferLocalTts: Boolean

Configures the TTS engine: local or remote.

Link copied to clipboard
var realLocationProviderFactory: DeviceLocationProviderFactory?

A DeviceLocationProviderFactory that contains a custom DeviceLocationProvider implementation used with Dash. NOTE: This implementation should emit only real locations (i. e. not simulated or fake).

Link copied to clipboard
var routeOptionsConfig: DashRouteOptionsConfig

Configures route options.

Link copied to clipboard
var searchConfig: DashSearchConfig

Configures Search.

Link copied to clipboard
var speedLimitsOptionsConfig: DashSpeedLimitsOptionsConfig

Configure speed limits options.

Link copied to clipboard
var themeConfig: DashThemeConfig

Configures appearance of Dash's UI elements.

Link copied to clipboard
var uiConfig: DashUiConfig

Configures UI.

Link copied to clipboard
var uiSettingsConfig: DashUiSettingsConfig

Configures UI Settings.

Link copied to clipboard
var unitOfMeasurement: String

Configures default unit of measurement.

Link copied to clipboard
var voicesConfig: DashVoicesConfig

Configures the voices used for Dash Navigation and MapGPT.

Link copied to clipboard
var weatherConfig: DashWeatherConfig

Configures Weather.

Functions

Link copied to clipboard
open override fun build(): DashConfig

Creates a new instance of DashConfig.

Link copied to clipboard
fun camera(func: DashCameraConfig.Builder.() -> Unit): DashConfig.Builder

Configures camera.

Link copied to clipboard
fun cameraConfig(func: DashCameraConfig.Builder.() -> Unit): DashConfig.Builder

Configures camera.

Link copied to clipboard
fun destinationPreview(func: DashDestinationPreviewConfig.Builder.() -> Unit): DashConfig.Builder

Configures DestinationPreview.

Link copied to clipboard
Link copied to clipboard
fun locationSimulation(func: DashLocationSimConfig.Builder.() -> Unit): DashConfig.Builder

Configures location simulation.

Link copied to clipboard
fun mapGpt(func: DashMapGptConfig.Builder.() -> Unit): DashConfig.Builder

Configures the Mapbox MapGPT feature used within Dash.

Link copied to clipboard
fun mapGptConfig(func: DashMapGptConfig.Builder.() -> Unit): DashConfig.Builder

Configures the Mapbox MapGPT feature used within Dash.

Link copied to clipboard
fun mapStyle(func: DashMapStyleConfig.Builder.() -> Unit): DashConfig.Builder

Configures the Mapbox Maps styles used with Dash. You can edit or create new ones via Mapbox Studio.

Link copied to clipboard
fun mapStyleConfig(func: DashMapStyleConfig.Builder.() -> Unit): DashConfig.Builder

Configures the Mapbox Maps styles used with Dash. You can edit or create new ones via Mapbox Studio.

Link copied to clipboard
fun routeOptions(func: DashRouteOptionsConfig.Builder.() -> Unit): DashConfig.Builder

Configures route options.

Link copied to clipboard
fun routeOptionsConfig(func: DashRouteOptionsConfig.Builder.() -> Unit): DashConfig.Builder

Configures route options.

Link copied to clipboard
fun search(func: DashSearchConfig.Builder.() -> Unit): DashConfig.Builder

Configures Search.

Link copied to clipboard
fun searchConfig(func: DashSearchConfig.Builder.() -> Unit): DashConfig.Builder

Configures Search.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun theme(func: DashThemeConfig.Builder.() -> Unit): DashConfig.Builder

Configures appearance of Dash's UI elements.

Link copied to clipboard
fun themeConfig(func: DashThemeConfig.Builder.() -> Unit): DashConfig.Builder

Configures appearance of Dash's UI elements.

Link copied to clipboard
fun ui(func: DashUiConfig.Builder.() -> Unit): DashConfig.Builder

Configure UI setup.

Link copied to clipboard
fun uiConfig(func: DashUiConfig.Builder.() -> Unit): DashConfig.Builder

Configure UI setup.

Link copied to clipboard
fun uiSettings(func: DashUiSettingsConfig.Builder.() -> Unit): DashConfig.Builder

Configures UI Settings.

Link copied to clipboard
fun uiSettingsConfig(func: DashUiSettingsConfig.Builder.() -> Unit): DashConfig.Builder

Configures UI Settings.

Link copied to clipboard
fun voices(func: DashVoicesConfig.Builder.() -> Unit): DashConfig.Builder

Configuration settings for the Text to Speech voices utilized by Dash.

Link copied to clipboard
fun voicesConfig(func: DashVoicesConfig.Builder.() -> Unit): DashConfig.Builder

Configuration settings for the Text to Speech voices utilized by Dash.

Link copied to clipboard
fun weather(func: DashWeatherConfig.Builder.() -> Unit): DashConfig.Builder

Configures Weather.

Link copied to clipboard
fun weatherConfig(func: DashWeatherConfig.Builder.() -> Unit): DashConfig.Builder

Configures Weather.