MTStyle

class MTStyle(reference: MTMapReferenceStyle, variant: MTMapStyleVariant? = null) : MTStylable

The proxy object for the current map style.

Set of convenience methods for style, sources and layers manipulation. MTStyle is null until map loading is complete.

Constructors

constructor(reference: MTMapReferenceStyle, variant: MTMapStyleVariant? = null)

Properties

var referenceStyle: MTMapReferenceStyle

Current reference style of the map object.

var styleVariant: MTMapStyleVariant?

Current style variant of the map object.

Functions

fun addLayer(layer: MTLayer)

Adds a layer to the map.

fun addLogoControl()

Adds the MapTiler logo control to the map.

open override fun addMarker(marker: MTMarker)

Adds the marker to the map.

fun addSource(source: MTSource)

Adds a source to the map.

open override fun addTextPopup(popup: MTTextPopup)

Adds a text popup to the map.

fun disableHalo()

Disables halo (animates out).

fun disableHaloAnimations()

Disables halo state transitions (animations).

fun disableSpaceAnimations()

Disables space state transitions (animations).

fun disableTerrain()

Disables the 3D terrain visualization.

fun enableGlobeProjection()

Enables the globe projection visualization.

fun enableHalo()

Enables halo with default gradient.

fun enableMercatorProjection()

Enables the mercator projection visualization.

fun enableTerrain(exaggerationFactor: Double? = null)

Enables the 3D terrain visualization.

suspend fun getIdForReferenceStyle(reference: MTMapReferenceStyle): String?

Returns SDK style id for a given reference style.

suspend fun getIdForStyleVariant(variant: MTMapStyleVariant): String?

Returns SDK style id for a given style variant.

suspend fun getNameForReferenceStyle(reference: MTMapReferenceStyle): String?

Returns display name for a given reference style.

suspend fun getNameForStyleVariant(variant: MTMapStyleVariant): String?

Returns display name for a given style variant.

suspend fun getProjection(): MTProjectionType?

Gets the current projection type if set.

fun getVariantsForCurrentReferenceStyle(): List<MTMapStyleVariant>?

Returns variants for the current reference style if they exist.

fun getVariantsForReferenceStyle(reference: MTMapReferenceStyle): List<MTMapStyleVariant>?

Returns variants for the provided reference style if they exist.

suspend fun isSourceLoaded(sourceId: String): Boolean

Returns boolean value indicating whether the source with provided id is loaded.

fun removeLayer(layer: MTLayer)

Removes a layer from the map.

open override fun removeMarker(marker: MTMarker)

Removes the marker from the map.

fun removeSource(source: MTSource)

Removes a source from the map.

open override fun removeTextPopup(popup: MTTextPopup)

Removes a text popup from the map.

fun setGlyphs(url: URL)

Sets the glyphs URL template.

fun setHalo(halo: MTHalo)

Sets the atmospheric halo (glow) configuration on the globe.

fun setLanguage(language: MTLanguage)

Sets the map language.

fun setLight(lightOptionsJson: String)

Sets the global light options for the current style. Provide a JSON object string compatible with MapLibre GL Light specification. Example: { "anchor": "viewport", "intensity": 0.5 }

fun setRenderWorldCopies(shouldRenderWorldCopies: Boolean)

Sets whether world copies should render.

fun setSpace(space: MTSpace)

Sets the globe space background (deep space/skybox). Any field not explicitly provided keeps its previous value.

fun setStyle(reference: MTMapReferenceStyle, variant: MTMapStyleVariant? = null)

Sets the current style by reference style and optional variant. Changing the style resets sources and layers.