navigation-ux-dash-config/com.mapbox.dash.sdk.config.dsl

Package-level declarations

Types

DashAnalyticsConfigInit

interface DashAnalyticsConfigInit

DashBorderCrossingNotificationConfigInit

interface DashBorderCrossingNotificationConfigInit : DashBorderCrossingNotificationConfigUpdate

DashBorderCrossingNotificationConfigUpdate

interface DashBorderCrossingNotificationConfigUpdate

DashCameraInit

interface DashCameraInit

DashDebugSettingsConfigInit

interface DashDebugSettingsConfigInit

DashDestinationPreviewInit

interface DashDestinationPreviewInit : DashDestinationPreviewUpdate

DashDestinationPreviewUpdate

interface DashDestinationPreviewUpdate

DashDriverNotificationConfigInit

interface DashDriverNotificationConfigInit : DashDriverNotificationConfigUpdate

DashDriverNotificationConfigUpdate

interface DashDriverNotificationConfigUpdate

DashEtaPanelConfigInit

interface DashEtaPanelConfigInit : DashEtaPanelConfigUpdate

DashEtaPanelConfigUpdate

interface DashEtaPanelConfigUpdate

DashFasterRouteNotificationConfigInit

interface DashFasterRouteNotificationConfigInit : DashFasterRouteNotificationConfigUpdate

DashFasterRouteNotificationConfigUpdate

interface DashFasterRouteNotificationConfigUpdate

DashFullScreenSearchUiUpdate

interface DashFullScreenSearchUiUpdate

DashLocationSimInit

interface DashLocationSimInit

DashMapGptInit

interface DashMapGptInit : DashMapGptUpdate

DashMapGptUpdate

interface DashMapGptUpdate

DashMapStyleInit

interface DashMapStyleInit : DashMapStyleUpdate

DashMapStyleUpdate

interface DashMapStyleUpdate

DashOfflineConfigInit

interface DashOfflineConfigInit

DashRouteOptionsInit

interface DashRouteOptionsInit : DashRouteOptionsUpdate

DashRouteOptionsUpdate

interface DashRouteOptionsUpdate

DashSearchInit

interface DashSearchInit : DashSearchUpdate

DashSearchPanelUpdate

interface DashSearchPanelUpdate

DashSearchUpdate

interface DashSearchUpdate

DashSidebarUpdate

interface DashSidebarUpdate

DashSlowTrafficNotificationConfigInit

interface DashSlowTrafficNotificationConfigInit : DashSlowTrafficNotificationConfigUpdate

DashSlowTrafficNotificationConfigUpdate

interface DashSlowTrafficNotificationConfigUpdate

DashSpeedLimitsInit

interface DashSpeedLimitsInit : DashSpeedLimitsUpdate

DashSpeedLimitsUpdate

interface DashSpeedLimitsUpdate

DashThemeInit

interface DashThemeInit : DashThemeUpdate

DashThemeUpdate

interface DashThemeUpdate

DashUiInit

interface DashUiInit : DashUiUpdate

DashUiSettingsInit

interface DashUiSettingsInit : DashUiSettingsUpdate

DashUiSettingsUpdate

interface DashUiSettingsUpdate

DashUiUpdate

interface DashUiUpdate

DashVoicesInit

interface DashVoicesInit : DashVoicesUpdate

DashVoicesUpdate

interface DashVoicesUpdate

Properties

analytics

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.analytics: DashAnalyticsConfig

Configuration for the analytics.

borderCrossingNotificationConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

val DashDriverNotificationConfig.borderCrossingNotificationConfig: DashBorderCrossingNotificationConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashDriverNotificationConfigUpdate.borderCrossingNotificationConfig: DashBorderCrossingNotificationConfig

Border crossing notification configuration.

cameraConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.cameraConfig: DashCameraConfig

Camera configuration.

CATEGORY_SEARCH_LIMIT_DEFAULT

const val CATEGORY_SEARCH_LIMIT_DEFAULT: Int = 10

CATEGORY_SEARCH_LIMIT_MAX

const val CATEGORY_SEARCH_LIMIT_MAX: Long = 24

debugSettingsConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.debugSettingsConfig: DashDebugSettingsConfig

Configuration for the debug settings.

DEFAULT_3D_STYLE

const val DEFAULT_3D_STYLE: String

Default 3D style.

DEFAULT_DAY_STYLE

const val DEFAULT_DAY_STYLE: String

Default day style.

DEFAULT_NIGHT_STYLE

const val DEFAULT_NIGHT_STYLE: String

Default night style.

DEFAULT_SATELLITE_STYLE

const val DEFAULT_SATELLITE_STYLE: String

Default satellite style.

destinationPreviewConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.destinationPreviewConfig: DashDestinationPreviewConfig

Configuration options for UI routing.

driverNotificationConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.driverNotificationConfig: DashDriverNotificationConfig

Driver notification configuration.

etaPanelConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.etaPanelConfig: DashEtaPanelConfig

ETA panel configuration.

fasterRouteNotificationConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

val DashDriverNotificationConfig.fasterRouteNotificationConfig: DashFasterRouteNotificationConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashDriverNotificationConfigUpdate.fasterRouteNotificationConfig: DashFasterRouteNotificationConfig

Faster route notification configuration.

leftSidebarConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

val DashUiConfig.leftSidebarConfig: DashSidebarConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashUiUpdate.leftSidebarConfig: DashSidebarConfig

Left sidebar configuration.

locationSimConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.locationSimConfig: DashLocationSimConfig

Configuration for the location simulation.

mapGptConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.mapGptConfig: DashMapGptConfig

Voice Assistant configuration.

mapStyleConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.mapStyleConfig: DashMapStyleConfig

Mapbox Maps styles configuration.

offlineConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.offlineConfig: DashOfflineConfig

QUERY_SEARCH_LIMIT_DEFAULT

const val QUERY_SEARCH_LIMIT_DEFAULT: Int = 10

QUERY_SEARCH_LIMIT_MAX

const val QUERY_SEARCH_LIMIT_MAX: Long = 10

rightSidebarConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

val DashUiConfig.rightSidebarConfig: DashSidebarConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashUiUpdate.rightSidebarConfig: DashSidebarConfig

Right sidebar configuration.

routeOptionsConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.routeOptionsConfig: DashRouteOptionsConfig

Configuration options for route options.

searchConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.searchConfig: DashSearchConfig

Search configuration.

searchPanelConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

val DashUiConfig.searchPanelConfig: DashSearchPanelConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashUiUpdate.searchPanelConfig: DashSearchPanelConfig

Search panel configuration.

slowTrafficNotificationConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

val DashDriverNotificationConfig.slowTrafficNotificationConfig: DashSlowTrafficNotificationConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashDriverNotificationConfigUpdate.slowTrafficNotificationConfig: DashSlowTrafficNotificationConfig

Slow traffic notification configuration.

speedLimitsOptionsConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.speedLimitsOptionsConfig: DashSpeedLimitsOptionsConfig

Configuration for speed limits options.

themeConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.themeConfig: DashThemeConfig

Dash UI elements appearance configuration.

uiConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.uiConfig: DashUiConfig

Ui configuration.

uiFullScreenSearchConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

val DashUiConfig.uiFullScreenSearchConfig: DashFullScreenSearchUiConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashUiUpdate.uiFullScreenSearchConfig: DashFullScreenSearchUiConfig

Full screen search ui configuration

uiSettingsConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.uiSettingsConfig: DashUiSettingsConfig

Configuration for settings screen.

voicesConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.voicesConfig: DashVoicesConfig

Voices configuration.

Functions

analytics

fun DashInit.analytics(f: DashAnalyticsConfigInit.() -> Unit)

Configures the analytics.

borderCrossingNotification

fun DashDriverNotificationConfigUpdate.borderCrossingNotification(f: DashBorderCrossingNotificationConfigUpdate.() -> Unit)

Re-configures the the border crossing notification

camera

fun DashInit.camera(f: DashCameraInit.() -> Unit)

Configures camera behavior.

debugSettings

fun DashInit.debugSettings(f: DashDebugSettingsConfigInit.() -> Unit)

Configures debug settings.

destinationPreview

fun DashInit.destinationPreview(f: DashDestinationPreviewInit.() -> Unit)

Configures UI routing.

fun DashUpdate.destinationPreview(f: DashDestinationPreviewUpdate.() -> Unit)

Re-configures UI routing.

driverNotification

fun DashInit.driverNotification(f: DashDriverNotificationConfigInit.() -> Unit)

Configures the driver notifications

fun DashUpdate.driverNotification(f: DashDriverNotificationConfigUpdate.() -> Unit)

Re-configures the driver notifications

etaPanel

fun DashInit.etaPanel(f: DashEtaPanelConfigInit.() -> Unit)

Configures the ETA panel.

fun DashUpdate.etaPanel(f: DashEtaPanelConfigUpdate.() -> Unit)

Re-configures the ETA panel.

fasterRouteNotification

fun DashDriverNotificationConfigUpdate.fasterRouteNotification(f: DashFasterRouteNotificationConfigUpdate.() -> Unit)

Re-configures the the faster route notification

leftSidebar

fun DashUiUpdate.leftSidebar(f: DashSidebarUpdate.() -> Unit)

Configures left sidebar properties.

locationSimulation

fun DashInit.locationSimulation(f: DashLocationSimInit.() -> Unit)

Configures the location simulation.

mapGpt

fun DashInit.mapGpt(f: DashMapGptInit.() -> Unit)

Configures voice assistant.

fun DashUpdate.mapGpt(f: DashMapGptUpdate.() -> Unit)

Re-configures voice assistant.

mapStyle

fun DashInit.mapStyle(f: DashMapStyleInit.() -> Unit)

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

fun DashUpdate.mapStyle(f: DashMapStyleUpdate.() -> Unit)

Re-configures the Mapbox Maps styles used with Dash.

offline

fun DashInit.offline(f: DashOfflineConfigInit.() -> Unit)

Configuration of the offline related features.

rightSidebar

fun DashUiUpdate.rightSidebar(f: DashSidebarUpdate.() -> Unit)

Configures Sidebar properties.

routeOptions

fun DashInit.routeOptions(f: DashRouteOptionsInit.() -> Unit)

Configures the route options.

fun DashUpdate.routeOptions(f: DashRouteOptionsUpdate.() -> Unit)

Re-configures the route options.

fun DashInit.search(f: DashSearchInit.() -> Unit)

Configures search.

fun DashUpdate.search(f: DashSearchUpdate.() -> Unit)

Re-configures search.

searchPanel

fun DashUiUpdate.searchPanel(f: DashSearchPanelUpdate.() -> Unit)

Configures search panel properties.

slowTrafficNotification

fun DashDriverNotificationConfigUpdate.slowTrafficNotification(f: DashSlowTrafficNotificationConfigUpdate.() -> Unit)

Re-configures the the slow traffic notification

speedLimitsOptions

fun DashInit.speedLimitsOptions(f: DashSpeedLimitsInit.() -> Unit)

Configures speed limits options.

fun DashUpdate.speedLimitsOptions(f: DashSpeedLimitsUpdate.() -> Unit)

Re-configures speed limits options.

theme

fun DashInit.theme(f: DashThemeInit.() -> Unit)

Configures appearance of Dash's UI elements.

fun DashUpdate.theme(f: DashThemeUpdate.() -> Unit)

Re-configures appearance of Dash's UI elements.

fun DashInit.ui(f: DashUiInit.() -> Unit)

Configures UI properties.

fun DashUpdate.ui(f: DashUiUpdate.() -> Unit)

Re-configures UI properties.

uiFullScreenSearchConfig

fun DashUiUpdate.uiFullScreenSearchConfig(f: DashFullScreenSearchUiUpdate.() -> Unit)

Configures full screen search ui

uiSettings

fun DashInit.uiSettings(f: DashUiSettingsInit.() -> Unit)

Configures UI Settings

fun DashUpdate.uiSettings(f: DashUiSettingsUpdate.() -> Unit)

Re-configures UI Settings

voices

fun DashInit.voices(f: DashVoicesInit.() -> Unit)

Configures the voices used for Dash Navigation and MapGPT.

fun DashUpdate.voices(f: DashVoicesUpdate.() -> Unit)

Re-configures the voices used for Dash Navigation and MapGPT.