View on GitHub Sample viewer app

Restrict zooming between specific scale ranges.

Image of set min and max scale

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

  1. Instantiate an ArcGISMap object.
  2. Set min and max scales of map with setMaxScale() and setMinScale().
  3. Set the map to a MapView object.

Relevant API

  • ArcGISMap
  • Basemap
  • MapView
  • ViewPoint

Tags

area of interest, level of detail, maximum, minimum, scale, viewpoint

Sample Code

MainActivity.kt MainActivity.kt SetMinAndMaxScaleViewModel.kt SetMinAndMaxScaleScreen.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.setminandmaxscale
import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
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.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)
)
}
}
}