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 addImage(identifier: String, image: Bitmap, options: MTAddImageOptions? = null)

Registers an image asset that can be referenced from the style.

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.

fun addSprite(identifier: String, url: URL)

Registers a sprite hosted at the provided URL under the given identifier.

open override fun addTextPopup(popup: MTTextPopup)

Adds a text popup to the map.

fun colorRampCollection(): MTColorRampCollection

Access to the collection of built-in color ramps.

suspend fun colorRampFromArrayDefinition(stops: List<MTArrayColorRampStop>): MTColorRamp

Creates a color ramp from an array definition.

suspend fun createColorRamp(options: MTColorRampOptions = MTColorRampOptions()): MTColorRamp

Creates a custom color ramp.

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. Defaults to MTProjectionType.MERCATOR when unavailable.

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.

fun heatmapHelper(): MTHeatmapLayerHelper

Returns a helper instance for adding heatmap layers.

suspend fun isSourceLoaded(sourceId: String): Boolean

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

fun playVideoSourceById(sourceId: String)

Starts playback for a video source by its identifier.

fun pointHelper(): MTPointLayerHelper

Returns a helper instance for adding point layers.

fun polygonHelper(): MTPolygonLayerHelper

Returns a helper instance for adding polygon layers.

fun polylineHelper(): MTPolylineLayerHelper

Returns a helper instance for adding polyline layers.

fun removeLayer(layer: MTLayer)

Removes a layer from the map.

fun removeLayerById(layerId: String)

Removes a layer by its identifier if present.

open override fun removeMarker(marker: MTMarker)

Removes the marker from the map.

fun removeSource(source: MTSource)

Removes a source from the map.

fun removeSourceById(sourceId: String)

Removes a source by its identifier if present.

open override fun removeTextPopup(popup: MTTextPopup)

Removes a text popup from the map.

fun MTStyle.setCircleColorStep(layerId: String, key: MTFeatureKey = MTFeatureKey.POINT_COUNT, defaultColor: Int, stops: List<Pair<Double, Int>>, includeAlpha: Boolean = false)
suspend fun MTStyle.setCircleColorStepAwait(layerId: String, key: MTFeatureKey = MTFeatureKey.POINT_COUNT, defaultColor: Int, stops: List<Pair<Double, Int>>, includeAlpha: Boolean = false)
fun MTStyle.setCircleRadiusStep(layerId: String, key: MTFeatureKey = MTFeatureKey.POINT_COUNT, defaultRadius: Double, stops: List<Pair<Double, Double>>)

Typed convenience helpers for common clustering styling patterns.

suspend fun MTStyle.setCircleRadiusStepAwait(layerId: String, key: MTFeatureKey = MTFeatureKey.POINT_COUNT, defaultRadius: Double, stops: List<Pair<Double, Double>>)
fun setFilter(layerId: String, filter: PropertyValue)
suspend fun setFilterAwait(layerId: String, filter: PropertyValue)
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 setLayoutProperty(layerId: String, name: String, value: PropertyValue)
suspend fun setLayoutPropertyAwait(layerId: String, name: String, value: PropertyValue)
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 setPaintProperty(layerId: String, name: String, value: PropertyValue)
suspend fun setPaintPropertyAwait(layerId: String, name: String, value: PropertyValue)
fun setRenderWorldCopies(shouldRenderWorldCopies: Boolean)

Sets whether world copies should render.

fun setSecondaryLanguage(language: MTLanguage)

Sets the map secondary language.

fun setSky(sky: MTSky)

Sets the sky appearance (colors, blends, or expressions). Any field not explicitly provided keeps its previous value.

fun setSpace(space: MTSpace)

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

fun setSprite(spriteUrl: String)

Updates the sprite of the map.

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

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

fun MTStyle.setTextAllowOverlap(layerId: String, allow: Boolean)
suspend fun MTStyle.setTextAllowOverlapAwait(layerId: String, allow: Boolean)
suspend fun MTStyle.setTextFieldTokenAwait(layerId: String, token: MTTextToken)
fun MTStyle.setTextSize(layerId: String, size: Double)
suspend fun MTStyle.setTextSizeAwait(layerId: String, size: Double)
fun stopVideoSourceById(sourceId: String)

Stops (pauses) playback for a video source by its identifier.

fun updateImage(identifier: String, image: Bitmap)

Updates an image with the given identifier.