On this page

    How To Migrate/Switch From MapLibre Native Android To MapTiler SDK Kotlin

    This tutorial provides guidance on transitioning from MapLibre Native Android to the MapTiler Kotlin SDK. If you currently use MapLibre’s Android SDK, switching to MapTiler Kotlin is straightforward.

    In most cases, you only need to replace the MapLibre dependency with the MapTiler SDK Kotlin, set the API key once in MTConfig, and swap MapLibre-specific classes/usages for the typed MapTiler SDK Kotlin APIs (MTMapView, MTMapOptions, MTMapReferenceStyle, MTMapViewController, etc.). You’ll also replace style URLs containing ?key=… with strong typed styles and language/terrain options.

    Next, see the main changes to migrate your app from MapLibre to MapTiler Kotlin.

    Installation

    Replace the Gradle dependency to use the MapTiler Kotlin SDK.

    MapLibre Native Android (Gradle)

    
    dependencies {
      implementation("org.maplibre.gl:android-sdk:<version>")
    }
    

    MapTiler SDK Kotlin (Gradle)

    
    dependencies {
      implementation("com.maptiler:maptiler-sdk-kotlin:{{site.versions.maptiler-android-kotlin}}")
    }
    

    Info

    Find the latest version of MapTiler SDK Kotlin at maptiler/maptiler-sdk-kotlin

    Replace MapLibre Classes With MapTiler SDK Types

    Search your app and replace MapLibre classes and helpers with MapTiler Kotlin equivalents. Some examples below.

    MapLibre Native Android

    
    // Declare a variable for MapView
    private lateinit var mapView: MapView
    
    // Declare a variable for MapLibreMap
    private lateinit var maplibreMap: MapLibreMap
    
    mapView.getMapAsync { map ->
      maplibreMap = map
    
      maplibreMap.setStyle("https://api.maptiler.com/maps/{{site.map-styles.streets}}/style.json?key=$KEY")
    }
    

    MapTiler SDK Kotlin - Compose

    
    MTConfig.apiKey = "YOUR_API_KEY"
    val controller = MTMapViewController(context)
    MTMapView(
      referenceStyle = MTMapReferenceStyle.STREETS,
      options = MTMapOptions(center = LngLat(8.5419, 47.3799), zoom = 10.68),
      controller = controller
    )
    

    MapTiler SDK Kotlin - XML

    
    MTConfig.apiKey = "YOUR_API_KEY"
    val controller = MTMapViewController(context)
    findViewById<MTMapViewClassic>(R.id.classicMapView).initialize(
      referenceStyle = MTMapReferenceStyle.STREETS,
      options = MTMapOptions(center = LngLat(8.5419, 47.3799), zoom = 10.68),
      controller = controller
    )
    

    Migrate The Basemap Styles

    Use MapTiler’s predefined styles without embedding ?key=… or hardcoding style versions.

    MapLibre Native Android

    
    val styleUrl = "https://api.maptiler.com/maps/{{site.map-styles.streets}}/style.json?key=$KEY" // versioned URL + key
    

    MapTiler SDK Kotlin

    
    // Always latest style; no URL or key in the string
    val reference = MTMapReferenceStyle.STREETS
    // Optional variant:
    styleVariant = MTMapStyleVariant.DARK
    

    Camera Animation

    MapLibre Native Android

    
    // Move camera
    val cameraPosition =
      CameraPosition.Builder()
        .target(nextLatLng)
        .zoom(zoom)
        .tilt(30.0)
        .build()
    maplibreMap.moveCamera(CameraUpdateFactory.newCameraPosition(cameraPosition))
    
    // Animate camera
    val cameraPosition =
      CameraPosition.Builder().target(nextLatLng).bearing(bearing).tilt(tilt).build()
    maplibreMap.animateCamera(
      CameraUpdateFactory.newCameraPosition(cameraPosition),
      7500,
      callback
    )
    

    MapTiler SDK Kotlin

    
    val controller = MTMapViewController(context)
    val cameraOptions = MTCameraOptions(center, zoom, bearing, pitch)
    controller.jumpTo(cameraOptions)
    controller.easeTo(cameraOptions)
    controller.flyTo(cameraOptions)
    

    Add Sources and Layers

    MapLibre Native Android

    
    val source = GeoJsonSource("mySource", URI("https://example.com/example.geojson")
    
    val lineLayer = LineLayer("myLayer", "source")
      .withProperties(
        PropertyFactory.lineColor(Color.RED),
        PropertyFactory.lineWidth(10f)
      )
    
    style.addSource(source)
    style.addLayer(lineLayer)
    

    MapTiler SDK Kotlin

    
    val source = MTGeoJSONSource(identifier = "mySource", url = URL("https://example.com/example.geojson"))
    val lineLayer = MTLineLayer(identifier = "myLayer", sourceIdentifier = source.identifier)
    lineLayer.sourceLayer = "contour"
    lineLayer.color = Color.RED
    lineLayer.width = 1.5
    controller.style?.addSource(source)
    controller.style?.addLayer(lineLayer)
    

    Custom Annotations

    While MapLibre Android uses annotations package to add map overlays, MapTiler SDK Kotlin uses MTCustomAnnotationView and MTCustomAnnotationViewClassic for Compose and XML respectively.

    
    // Compose: Place MTCustomAnnotationView as a sibling composable above MTMapView
    // inside a stacking container (e.g., Box)
    MTCustomAnnotationView(
      controller = controller,
      coordinates = LngLat(14.42076, 50.08804),
      modifier = Modifier
    ) {
      // Your composable (e.g., Card/Text/Icon)
    }
    // XML: MTCustomAnnotationViewClassic is a container: add your own child Android Views
    // into it to render custom UI.
    val annotation = MTCustomAnnotationViewClassic(
      context = this,
      widthPx = 120, heightPx = 48,
      initialCoordinates = LngLat(14.42076, 50.08804)
    )
    // Inflate your custom layout into the container
    LayoutInflater.from(this).inflate(R.layout.my_custom_layout, annotation, true)
    annotation.addTo(mapView, controller)
    

    For more info take a look at our custom annotations example.

    Markers, Globe and Space

    MapTiler SDK Kotlin also gives you options to change map projection to Globe, add space background behind it and annotate your data with markers.

    Compose

    
    // Set once in your app (e.g., Application.onCreate)
    MTConfig.apiKey = "YOUR_API_KEY"
    val controller = MTMapViewController(context).apply {
      // Add marker only after the map is ready
      delegate = object : MTMapViewDelegate {
        override fun onMapViewInitialized() {
          // Map is initialized
        }
        override fun onEventTriggered(event: MTEvent, data: MTData?) {
          if (event == MTEvent.ON_READY) {
            val location = LngLat(14.42076, 50.08804)
            style?.addMarker(MTMarker(location))
          }
        }
      }
    }
    // Enable globe projection and add space background behind it
    val options = MTMapOptions(
      projection = MTProjectionType.GLOBE,
      space = MTSpaceOption.Config(
        MTSpace(preset = MTSpacePreset.MILKYWAY_COLORED)
      )
    )
    MTMapView(
      referenceStyle = MTMapReferenceStyle.AQUARELLE,
      options = options,
      controller = controller,
      modifier = Modifier.fillMaxSize()
    )
    

    XML

    
    // XML layout contains: <com.maptiler.maptilersdk.map.MTMapViewClassic android:id="@+id/classicMapView" ... />
    MTConfig.apiKey = "YOUR_API_KEY"
    val controller = MTMapViewController(this).apply {
      delegate = object : MTMapViewDelegate {
        override fun onMapViewInitialized() {
          // Map is initialized
        }
        override fun onEventTriggered(event: MTEvent, data: MTData?) {
          if (event == MTEvent.ON_READY) {
            style?.addMarker(MTMarker(LngLat(14.42076, 50.08804)))
          }
        }
      }
    }
    val options = MTMapOptions(
      projection = MTProjectionType.GLOBE,
      space = MTSpaceOption.Config(MTSpace(preset = MTSpacePreset.MILKYWAY_COLORED))
    )
    val classic = findViewById<MTMapViewClassic>(R.id.classicMapView)
    classic.initialize(
      referenceStyle = MTMapReferenceStyle.AQUARELLE,
      options = options,
      controller = controller
    )
    
    Migrate/Switch From MapLibre Android To MapTiler SDK Kotlin

    Was this helpful?

    Mobile SDK
    Android
    How To Migrate/Switch From MapLibre Native Android To MapTiler SDK Kotlin
    Migrate/Switch From MapLibre