Limit the view of a map to a particular area.
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
ArcGISMapobject. - 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
MapViewobject. - Set
map.maxExtent = nullto 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.
Tags
extent, geoview-compose, limit panning, map, mapview, max extent, toolkit, zoom
Sample Code
/* 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 } }