Restrict zooming between specific scale ranges.

Use case
Data may only appear at a certain scale on a map, and may be visually lost if zooming too far in or out. Setting the minimum and maximum scales ensures the zoom extents are appropriately limited for the purposes of the map.
How to use the sample
Zoom in and out of the map. The zoom extents of the map are limited between the given minimum and maximum scales.
How it works
- Instantiate an
ArcGISMapobject. - Set min and max scales of map with
setMaxScale()andsetMinScale(). - Set the map to a
MapViewobject.
Relevant API
- ArcGISMap
- Basemap
- MapView
- ViewPoint
Tags
area of interest, level of detail, maximum, minimum, scale, viewpoint
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.setminandmaxscale
import android.os.Bundleimport androidx.activity.ComponentActivityimport androidx.activity.compose.setContentimport androidx.compose.material3.MaterialThemeimport androidx.compose.material3.Surfaceimport androidx.compose.runtime.Composableimport com.arcgismaps.ApiKeyimport com.arcgismaps.ArcGISEnvironmentimport com.esri.arcgismaps.sample.sampleslib.theme.SampleAppThemeimport com.esri.arcgismaps.sample.setminandmaxscale.screens.SetMinAndMaxScaleScreen
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 { SetMinAndMaxScaleApp() } } }
@Composable private fun SetMinAndMaxScaleApp() { Surface(color = MaterialTheme.colorScheme.background) { SetMinAndMaxScaleScreen( sampleName = getString(R.string.set_min_and_max_scale_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.setminandmaxscale.components
import android.app.Applicationimport androidx.lifecycle.AndroidViewModelimport androidx.lifecycle.viewModelScopeimport com.arcgismaps.mapping.ArcGISMapimport com.arcgismaps.mapping.BasemapStyleimport com.arcgismaps.mapping.Viewpointimport com.esri.arcgismaps.sample.sampleslib.components.MessageDialogViewModelimport kotlinx.coroutines.launch
/** * ViewModel for the SetMinAndMaxScale sample. */class SetMinAndMaxScaleViewModel(application: Application) : AndroidViewModel(application) {
// Expose the map as a mutable state so the Compose UI can observe changes. var arcGISMap = ArcGISMap(BasemapStyle.ArcGISStreets).apply { // Set an initial viewpoint. initialViewpoint = Viewpoint(39.8, -98.6, 10e7) // Set sample min and max scales to demonstrate enforcing zoom limits. // Note: minScale represents the most zoomed-out denominator and // maxScale the most zoomed-in denominator. minScale = 8000.0 maxScale = 2000.0 }
// Message dialog VM to show any errors during load. val messageDialogVM = MessageDialogViewModel()
init { // Load the map and surface any load failures via the message dialog VM. viewModelScope.launch { arcGISMap.load().onFailure { throwable -> messageDialogVM.showMessageDialog(throwable) } } }}/* 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.setminandmaxscale.screens
import androidx.compose.foundation.layout.fillMaxSizeimport androidx.compose.foundation.layout.paddingimport androidx.compose.material3.Scaffoldimport androidx.compose.runtime.Composableimport androidx.compose.ui.Modifierimport androidx.lifecycle.viewmodel.compose.viewModelimport com.arcgismaps.toolkit.geoviewcompose.MapViewimport com.esri.arcgismaps.sample.setminandmaxscale.components.SetMinAndMaxScaleViewModelimport com.esri.arcgismaps.sample.sampleslib.components.MessageDialogimport com.esri.arcgismaps.sample.sampleslib.components.SampleTopAppBar
/** * Main screen for the SetMinAndMaxScale sample. */@Composablefun SetMinAndMaxScaleScreen(sampleName: String) { val mapViewModel: SetMinAndMaxScaleViewModel = viewModel()
Scaffold( topBar = { SampleTopAppBar(title = sampleName) }, content = { padding -> MapView( modifier = Modifier .fillMaxSize() .padding(padding), arcGISMap = mapViewModel.arcGISMap ) // Display any load error messages coming from the ViewModel's MessageDialogViewModel mapViewModel.messageDialogVM.apply { if (dialogStatus) { MessageDialog( title = messageTitle, description = messageDescription, onDismissRequest = ::dismissDialog ) } } } )}