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

Builder

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

@Serializable

class Builder : DashConfigBuilder<DashUiConfig, DashUiConfig.Builder> , DashUiInit

Creates a new instance of DashUiConfig.

Constructors

Builder

constructor()

Properties

customValues

open var customValues: MutableMap<String, Any?>

Map of custom configuration key -> value pairs.

leftSidebarConfig

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

var DashUiUpdate.leftSidebarConfig: DashSidebarConfig

Left sidebar configuration.

mapIncidentsVisibility

open override var mapIncidentsVisibility: Int

Policy that controls incidents visibility on the map. See MapIncidentsVisibility for all possible values.

mapTrafficLightsVisibility

open override var mapTrafficLightsVisibility: Int

Policy that controls traffic lights visibility on the map. See MapTrafficLightsVisibility for all possible values.

mapTrafficVisibility

open override var mapTrafficVisibility: Int

Policy that controls traffic information visibility on the map. See MapTrafficVisibility for all possible values.

rightSidebarConfig

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

var DashUiUpdate.rightSidebarConfig: DashSidebarConfig

Right sidebar configuration.

searchPanelConfig

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

var DashUiUpdate.searchPanelConfig: DashSearchPanelConfig

Search panel configuration.

showCloseButtonInCards

open override var showCloseButtonInCards: Boolean

Controls whether close button is visible in cards (POI, category search, settings and others).

showIncidentsOnRouteLine

open override var showIncidentsOnRouteLine: Boolean

Controls whether detected incidents should appear on the route line.

showIntersectionsDataOnRouteLine

open override var showIntersectionsDataOnRouteLine: Boolean

Controls whether intersections data should appear on the route line.

streetNameVisibility

open override var streetNameVisibility: Int

Policy that controls street name view visibility. See StreetNameVisibility for all possible values.

uiFullScreenSearchConfig

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

var DashUiUpdate.uiFullScreenSearchConfig: DashFullScreenSearchUiConfig

Full screen search ui configuration

uiModeMapper

open override var uiModeMapper: UiModeMapper

Mapper instance that maps the UiMode and UiModeSettings to a single UiMode type.

uiModeSettings

open override var uiModeSettings: String

The UiModeSettings that controls whether Dark or Light theme and map style should be used. See UiModeSettings for all possible values.

Functions

build

open override fun build(): DashUiConfig

Creates a new instance of DashUiConfig.

leftSidebar

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

Configures left sidebar properties.

rightSidebar

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

Configures Sidebar properties.

searchPanel

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

Configures search panel properties.

uiFullScreenSearchConfig

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

Configures full screen search ui