Display Composable MapView

View on GitHub

Sample viewer app

Display a map using Jetpack Compose.

Image of display composable mapview

Use case

Android Jetpack Compose is designed to be more efficient and performant than XML layouts. It allows you to define UI in a more declarative and composable way. Compose is also designed to work seamlessly with Kotlin. Visit the Android doc, why adopt Compose? to learn more.

How to use the sample

Run the sample to view the map. Pan and zoom to navigate the map.

How it works

Create a custom @Composable function to wrap the MapView
Use AndroidView to wrap a classic Android view in a Compose UI.
Set its Modifier to define the MapView layout parameters
Use its factory parameter to provide context and create MapView(context)
Add the MapView to the lifecycle observer
Add the composable content to the Activity using setContent { }

Relevant API

ArcGISMap
BasemapStyle
MapView

Additional information

This sample uses the GeoViewCompose Toolkit module to be able to implement a Composable MapView.

Sample Code

MainActivity.kt
Use dark colors for code blocksCopy
/* Copyright 2023 Esri
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package com.esri.arcgismaps.sample.displaycomposablemapview

import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.Scaffold
import androidx.compose.ui.Modifier
import com.arcgismaps.ApiKey
import com.arcgismaps.ArcGISEnvironment
import com.arcgismaps.mapping.ArcGISMap
import com.arcgismaps.mapping.BasemapStyle
import com.arcgismaps.toolkit.geoviewcompose.MapView
import com.esri.arcgismaps.sample.sampleslib.components.SampleTopAppBar
import com.esri.arcgismaps.sample.sampleslib.theme.SampleAppTheme

class MainActivity : ComponentActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        // authentication with an API key or named user is
        // required to access basemaps and other location services
        ArcGISEnvironment.apiKey = ApiKey.create(BuildConfig.ACCESS_TOKEN)

        setContent {
            SampleAppTheme {
                Scaffold(topBar = { SampleTopAppBar(getString(R.string.display_composable_map_view_app_name)) }) {
                    // create a map with a navigation night basemap style
                    val map = ArcGISMap(BasemapStyle.ArcGISNavigationNight)
                    MapView(
                        modifier = Modifier
                            .fillMaxSize()
                            .padding(it),
                        arcGISMap = map
                    )
                }
            }
        }
    }
}