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
ArcGISMap
object. - Set min and max scales of map with
map.minScale
andmap.maxScale
. - Pass the map to a
MapView
object.
Relevant API
- ArcGISMap
- BasemapStyle
- MapView
- ViewPoint
Tags
area of interest, level of detail, maximum, minimum, scale, viewpoint
Sample Code
MainActivity.kt
/*
* Copyright 2019 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.arcgisruntime.samples.setminxmaxscale
import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment
import com.esri.arcgisruntime.geometry.Point
import com.esri.arcgisruntime.geometry.SpatialReferences
import com.esri.arcgisruntime.mapping.ArcGISMap
import com.esri.arcgisruntime.mapping.BasemapStyle
import com.esri.arcgisruntime.mapping.Viewpoint
import com.esri.arcgisruntime.mapping.view.MapView
import com.esri.arcgisruntime.samples.setminxmaxscale.databinding.ActivityMainBinding
class MainActivity : AppCompatActivity() {
private val activityMainBinding by lazy {
ActivityMainBinding.inflate(layoutInflater)
}
private val mapView: MapView by lazy {
activityMainBinding.mapView
}
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(activityMainBinding.root)
// authentication with an API key or named user is required to access basemaps and other
// location services
ArcGISRuntimeEnvironment.setApiKey(BuildConfig.API_KEY)
// create a ArcGISMap with basemap streets
with(ArcGISMap(BasemapStyle.ARCGIS_STREETS)) {
// set the scale at which this layer can be viewed
this.minScale = 8000.0
this.maxScale = 2000.0
// set the ArcGISMap instance to display in the MapView
mapView.map = this
// set point where the map view will focus and zoom to
mapView.setViewpoint(
Viewpoint(
Point(
-355453.0,
7548720.0,
SpatialReferences.getWebMercator()
), 3000.0
)
)
}
}
override fun onResume() {
super.onResume()
mapView.resume()
}
override fun onPause() {
mapView.pause()
super.onPause()
}
override fun onDestroy() {
mapView.dispose()
super.onDestroy()
}
}