navigation-ux-dash-config/com.mapbox.dash.sdk.config.api/DashMapStyleConfig

DashMapStyleConfig

class DashMapStyleConfig : DashConfigBase<DashMapStyleConfig, DashMapStyleConfig.Builder>

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

Parameters

dayStyleUri

DAY style URI.

nightStyleUri

NIGHT style URI.

satelliteStyleUri

SATELLITE style URI.

map3dStyleUri

3D MAP style URI.

pixelRatio

the map custom pixel ratio. By default, it is set to null If provided and enabled in settings, supersedes both dayStyleUri and nightStyleUri.

IMPORTANT: 3D styles are very specific in the way they need to be built to support day/night mode switch. Consult with Mapbox Support before overriding this value.

Types

Builder

class Builder : DashConfigBuilder<DashMapStyleConfig, DashMapStyleConfig.Builder>

Creates a new instance of DashMapStyleConfig.

Companion

object Companion

Update

class Update : ConfigUpdate<DashMapStyleConfig>

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

Properties

customValues

val customValues: Map<String, Any>

dayStyleUri

val dayStyleUri: String

map3dStyleUri

val map3dStyleUri: String

nightStyleUri

val nightStyleUri: String

pixelRatio

val pixelRatio: Float?

satelliteStyleUri

val satelliteStyleUri: String

Functions

copy

fun <T, B : DashConfigBuilder<T, B>> DashConfigBase<T, B>.copy(func: B.() -> Unit): T

Creates a copy of a given configuration instances with options mutated by the provided function.

equals

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

hashCode

open override fun hashCode(): Int

toBuilder

open override fun toBuilder(): DashMapStyleConfig.Builder

Returns a new Builder instance with copied elements of this configuration.

toString

open override fun toString(): String