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
Tags
extent, limit panning, map, mapview, max extent, zoom
Sample Code
MainActivity.kt
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/* Copyright 2022 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.sample.setmaxextent
import android.graphics.Color
import android.os.Bundle
import android.widget.TextView
import androidx.appcompat.app.AppCompatActivity
import androidx.appcompat.widget.SwitchCompat
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment
import com.esri.arcgisruntime.geometry.Envelope
import com.esri.arcgisruntime.geometry.Point
import com.esri.arcgisruntime.mapping.ArcGISMap
import com.esri.arcgisruntime.mapping.BasemapStyle
import com.esri.arcgisruntime.mapping.view.Graphic
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay
import com.esri.arcgisruntime.mapping.view.MapView
import com.esri.arcgisruntime.sample.setmaxextent.databinding.ActivityMainBinding
import com.esri.arcgisruntime.symbology.SimpleLineSymbol
import com.esri.arcgisruntime.symbology.SimpleRenderer
classMainActivity : AppCompatActivity() {
privateval activityMainBinding by lazy {
ActivityMainBinding.inflate(layoutInflater)
}
privateval mapView: MapView by lazy {
activityMainBinding.mapView
}
privateval extentSwitch: SwitchCompat by lazy {
activityMainBinding.extentSwitch
}
privateval extentTextView: TextView by lazy {
activityMainBinding.extentText
}
privateval extentEnvelope =
Envelope(Point(-12139393.2109, 5012444.0468), Point(-11359277.5124, 4438148.7816))
overridefunonCreate(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 map with the BasemapStyle streets focused on Coloradoval coloradoMap = ArcGISMap(BasemapStyle.ARCGIS_STREETS).apply {
// set the map's max extent to an envelope of Colorado's northwest and southeast corners maxExtent = extentEnvelope
}
// create a graphics overlay of the map's max extentval 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(SimpleLineSymbol.Style.DASH, Color.RED, 5f))
}
extentSwitch.setOnCheckedChangeListener { _, isChecked ->
if (isChecked) {
// set max extent to the state of Colorado coloradoMap.maxExtent = extentEnvelope
extentTextView.text = getString(R.string.extentEnable)
} else {
// disable the max extent of the map, map is free to pan around coloradoMap.maxExtent = null extentTextView.text = getString(R.string.extentDisable)
}
}
mapView.apply {
// set the map to the map view map = coloradoMap
// set the graphics overlay to the map view graphicsOverlays.add(coloradoGraphicsOverlay)
}
}
overridefunonPause() {
mapView.pause()
super.onPause()
}
overridefunonResume() {
super.onResume()
mapView.resume()
}
overridefunonDestroy() {
mapView.dispose()
super.onDestroy()
}
}