maplibre-native-bindings/org.maplibre.kmp.native.map

Package-level declarations

Types

data class BoundOptions(val bounds: LatLngBounds? = null, val minZoom: Double? = null, val maxZoom: Double? = null, val minPitch: Double? = null, val maxPitch: Double? = null)

Options to limit what parts of a map are visible. All fields are optional.

CanvasRenderer

class CanvasRenderer(canvas: Canvas, pixelRatio: Float) : RendererFrontend

ClientOptions

data class ClientOptions(val name: String = "MapLibre Native for JVM", val version: String = "TODO")

Configuration options for client identification. This is a simple data holder that identifies the client application.

ConstrainMode

enum ConstrainMode : Enum<ConstrainMode>

MapCanvas

class MapCanvas(mapObserver: MapObserver, mapOptions: MapOptions = MapOptions(), resourceOptions: ResourceOptions = ResourceOptions(), clientOptions: ClientOptions = ClientOptions(), onMapReady: (MapLibreMap, MapCanvas) -> Unit = { _, _ -> }) : Canvas

A Canvas that automatically initializes and manages a MapLibre map. This class encapsulates all the initialization logic and provides a callback when the map is ready for configuration.

MapControls

class MapControls(component: Component, map: MapLibreMap, var config: MapControls.Config = Config(), observer: MapControls.Observer? = null) : MouseListener, MouseMotionListener, MouseWheelListener, KeyListener

Handles user interactions (mouse and keyboard) for a MapLibre map.

MapDebugOptions

@JvmInline

value class MapDebugOptions(val value: Int = 0)

Debug options for the map renderer. Each property represents a debug feature that can be enabled. Multiple options can be enabled simultaneously.

MapLibreMap

class MapLibreMap(frontend: RendererFrontend, observer: MapObserver, options: MapOptions, resourceOptions: ResourceOptions, clientOptions: ClientOptions)

MapLoadError

enum MapLoadError : Enum<MapLoadError>

MapMode

enum MapMode : Enum<MapMode>

MapObserver

interface MapObserver

MapOptions

data class MapOptions(val mapMode: MapMode = MapMode.CONTINUOUS, val constrainMode: ConstrainMode = ConstrainMode.HEIGHT_ONLY, val viewportMode: ViewportMode = ViewportMode.DEFAULT, val crossSourceCollisions: Boolean = true, val northOrientation: NorthOrientation = NorthOrientation.UPWARDS, val size: Size = Size(64, 64), val pixelRatio: Float = 1.0f)

Configuration options for initializing a Map. This is a simple data holder that specifies various map settings.

NorthOrientation

enum NorthOrientation : Enum<NorthOrientation>

RendererFrontend

interface RendererFrontend

RenderFrameStatus

data class RenderFrameStatus(val mode: RenderMode, val needsRepaint: Boolean, val placementChanged: Boolean, val renderingStats: RenderingStats)

RenderingStats

data class RenderingStats(val encodingTime: Double, val renderingTime: Double, val numFrames: Int, val numDrawCalls: Int, val totalDrawCalls: Int, val numCreatedTextures: Int, val numActiveTextures: Int, val numTextureBindings: Int, val numTextureUpdates: Int, val textureUpdateBytes: Long, val totalBuffers: Long, val totalBufferObjs: Long, val bufferUpdates: Long, val bufferObjUpdates: Long, val bufferUpdateBytes: Long, val numBuffers: Int, val numFrameBuffers: Int, val numIndexBuffers: Int, val indexUpdateBytes: Long, val numVertexBuffers: Int, val vertexUpdateBytes: Long, val numUniformBuffers: Int, val numUniformUpdates: Int, val uniformUpdateBytes: Long, val memTextures: Int, val memBuffers: Int, val memIndexBuffers: Int, val memVertexBuffers: Int, val memUniformBuffers: Int, val stencilClears: Int, val stencilUpdates: Int)

RenderMode

enum RenderMode : Enum<RenderMode>

ResourceOptions

data class ResourceOptions(val apiKey: String = "", val tileServerOptions: TileServerOptions = TileServerOptions.DemoTiles, val cachePath: String = "maplibre-cache", val assetPath: String = "", val maximumCacheSize: Long = 50 * 1024 * 1024)

TileServerOptions

data class TileServerOptions(val baseURL: String = "https://api.mapbox.com", val uriSchemeAlias: String = "mapbox://", val apiKeyParameterName: String = "access_token", val requiresApiKey: Boolean = false, val sourceTemplate: TileServerTemplate = TileServerTemplate("https://api.mapbox.com"), val styleTemplate: TileServerTemplate = TileServerTemplate("/styles/v1/{user}/{style}"), val spritesTemplate: TileServerTemplate = TileServerTemplate("/styles/v1/{user}/{style}/sprite"), val glyphsTemplate: TileServerTemplate = TileServerTemplate("/fonts/v1/{user}/{fontstack}/{range}.pbf"), val tileTemplate: TileServerTemplate = TileServerTemplate("/v4/{tileset}/{z}/{x}/{y}{ratio}.{format}"), val defaultStyle: String = "")

Configuration for tile server endpoints and URL templates. This configures how MapLibre connects to map data providers.

TileServerTemplate

data class TileServerTemplate(val template: String, val domainName: String = "", val versionPrefix: String? = null)

ViewportMode

enum ViewportMode : Enum<ViewportMode>