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

DashMapStyleConfig

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])
@Serializable
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

markerFactory

Factory for creating markers for symbol descriptors. 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.

Properties

Link copied to clipboard
@Serializable(with = RedactedMapSerializer::class)
open override val customValues: MutableMap<String, Any?>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])
fun DashMapStyleConfig.allStyles(withSatellite: Boolean = true): List<String>

Returns list of all usable styles.

Link copied to clipboard
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.

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])
fun DashMapStyleConfig.satelliteStyles(): List<String>

Returns list of all satellite usable styles.

Link copied to clipboard
open override fun toBuilder(): DashMapStyleConfig.Builder

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

Link copied to clipboard
open override fun toString(): String