Set max extent | ArcGIS Maps SDK for Kotlin

View on GitHub

Sample viewer app

Limit the view of a map to a particular area.

Image of set max extent

Use case

When showing map information relevant to only a certain area, you may wish to constrain the user’s ability to pan or zoom away.

How to use the sample

The application loads with a map whose maximum extent has been set to the borders of Colorado. Note that you won’t be able to pan far from the Colorado border or zoom out beyond the minimum scale set by the max extent. Use the toggle switch to disable the max extent to freely pan/zoom around the map.

How it works

Create an ArcGISMap object.
Create an envelop of the extent using Envelope(Point(x, y), Point(x, y))
Set the maximum extent of the map with map.maxExtent = envelope.
Set the map to a MapView object.
Set map.maxExtent = null to disable the maximum extent of the map

Relevant API

ArcGISMap
Envelope

Additional information

This sample uses the GeoView-Compose Toolkit module to be able to implement a composable MapView.

Sample Code

MainActivity.kt

SetMaxExtentViewModel.kt

SetMaxExtentScreen.kt

/* Copyright 2025 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.setmaxextent

import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.activity.enableEdgeToEdge
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Surface
import androidx.compose.runtime.Composable
import com.arcgismaps.ApiKey
import com.arcgismaps.ArcGISEnvironment
import com.esri.arcgismaps.sample.sampleslib.theme.SampleAppTheme
import com.esri.arcgismaps.sample.setmaxextent.screens.SetMaxExtentScreen

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)

        enableEdgeToEdge()
        setContent {
            SampleAppTheme {
                SetMaxExtentApp()
            }
        }
    }

    @Composable
    private fun SetMaxExtentApp() {
        Surface(color = MaterialTheme.colorScheme.background) {
            SetMaxExtentScreen(
                sampleName = getString(R.string.set_max_extent_app_name)
            )
        }
    }
}

/* Copyright 2025 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.setmaxextent.components

import android.app.Application
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.setValue
import androidx.lifecycle.AndroidViewModel
import androidx.lifecycle.viewModelScope
import com.arcgismaps.Color
import com.arcgismaps.geometry.Envelope
import com.arcgismaps.geometry.Point
import com.arcgismaps.mapping.ArcGISMap
import com.arcgismaps.mapping.BasemapStyle
import com.arcgismaps.mapping.symbology.SimpleLineSymbol
import com.arcgismaps.mapping.symbology.SimpleLineSymbolStyle
import com.arcgismaps.mapping.symbology.SimpleRenderer
import com.arcgismaps.mapping.view.Graphic
import com.arcgismaps.mapping.view.GraphicsOverlay
import com.esri.arcgismaps.sample.sampleslib.components.MessageDialogViewModel
import kotlinx.coroutines.launch

class SetMaxExtentViewModel(app: Application) : AndroidViewModel(app) {

    // defines an envelope representing a rectangular area
    private val extentEnvelope = Envelope(
        Point(-12139393.2109, 5012444.0468),
        Point(-11359277.5124, 4438148.7816)
    )

    // create a map with the BasemapStyle streets focused on Colorado
    val coloradoMap = ArcGISMap(BasemapStyle.ArcGISStreets).apply {
        // set the map's max extent to an envelope of Colorado's northwest and southeast corners
        maxExtent = extentEnvelope
    }

    // Create a message dialog view model for handling error messages
    val messageDialogVM = MessageDialogViewModel()

    init {
        viewModelScope.launch {
            coloradoMap.load().onFailure { messageDialogVM.showMessageDialog(it) }
        }
    }

    // create a graphics overlay of the map's max extent
    val coloradoGraphicsOverlay = GraphicsOverlay().apply {
        // set the graphic's geometry to the max extent of the map
        graphics.add(Graphic(coloradoMap.maxExtent))
        // create a simple red dashed line renderer
        renderer = SimpleRenderer(SimpleLineSymbol(SimpleLineSymbolStyle.Dash, Color.red, 5f))
    }

    // graphics overlays that are applied to the map
    val graphicsOverlays = listOf(coloradoGraphicsOverlay)

    // tracks whether the max extent feature is currently enabled.
    var maxExtentEnabled by mutableStateOf(true)

    // this function is called when the switch is toggled.
    fun onSwitch(isChecked: Boolean){
        // set max extent to the state of Colorado
        if(isChecked) {
            coloradoMap.maxExtent = extentEnvelope
        }
        // disable the max extent of the map, map is free to pan around
        else {
            coloradoMap.maxExtent = null
        }

        maxExtentEnabled = isChecked
    }
}

/* Copyright 2025 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.setmaxextent.screens

import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Switch
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp
import androidx.lifecycle.viewmodel.compose.viewModel
import com.arcgismaps.toolkit.geoviewcompose.MapView
import com.esri.arcgismaps.sample.setmaxextent.components.SetMaxExtentViewModel
import com.esri.arcgismaps.sample.sampleslib.components.MessageDialog
import com.esri.arcgismaps.sample.sampleslib.components.SampleTopAppBar
import com.esri.arcgismaps.sample.setmaxextent.R

/**
 * Main screen layout for the sample app
 */
@Composable
fun SetMaxExtentScreen(sampleName: String) {
    val mapViewModel: SetMaxExtentViewModel = viewModel()

    Scaffold(
        topBar = { SampleTopAppBar(title = sampleName) },
        content = {
            Column(
                modifier = Modifier
                    .fillMaxSize()
                    .padding(it)
            ) {
                MapView(
                    modifier = Modifier
                        .fillMaxSize()
                        .weight(1f),
                    arcGISMap = mapViewModel.coloradoMap,
                    graphicsOverlays = mapViewModel.graphicsOverlays
                )
                Row(
                    modifier = Modifier
                        .fillMaxWidth()
                        .padding(5.dp),
                    horizontalArrangement = Arrangement.SpaceBetween
                ) {
                    Text(
                        if (mapViewModel.maxExtentEnabled)
                            stringResource(R.string.max_extent_enabled)
                        else
                            stringResource(R.string.max_extent_disabled),
                        modifier = Modifier.align(Alignment.CenterVertically))
                    Switch (
                        checked = mapViewModel.maxExtentEnabled,
                        onCheckedChange = mapViewModel::onSwitch,
                        modifier = Modifier.align(Alignment.CenterVertically)
                    )
                }
            }

            mapViewModel.messageDialogVM.apply {
                if (dialogStatus) {
                    MessageDialog(
                        title = messageTitle,
                        description = messageDescription,
                        onDismissRequest = ::dismissDialog
                    )
                }
            }
        }
    )
}