Set max extent

View inMAUIWinUIWPFView on GitHubSample viewer app

Limit the view of a map to a particular area.

Image of set max extent

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 control to disable the max extent to freely pan/zoom around the map.

How it works

  1. Create a Map object.
  2. Create an envelope of the extent.
  3. Set the map to a MapView object.
  4. Set the maximum extent of the map with map.MaxExtent = extentEnvelope.
  5. Set MaxExtent to null to disable the maximum extent of the map.

Relevant API

  • Envelope
  • Map

Tags

extent, limit panning, map, mapview, max extent, zoom

Sample Code

SetMaxExtent.xaml.csSetMaxExtent.xaml.csSetMaxExtent.xaml
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
// 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.

using Esri.ArcGISRuntime.Geometry;
using Esri.ArcGISRuntime.Mapping;
using Esri.ArcGISRuntime.Symbology;
using Esri.ArcGISRuntime.UI;

namespace ArcGIS.WPF.Samples.SetMaxExtent
{
    [ArcGIS.Samples.Shared.Attributes.Sample(
        name: "Set max extent",
        category: "Map",
        description: "Limit the view of a map to a particular area.",
        instructions: "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 control to disable the max extent to freely pan/zoom around the map.",
        tags: new[] { "extent", "limit panning", "map", "mapview", "max extent", "zoom" })]
    public partial class SetMaxExtent
    {
        // Hold a reference to the extent envelope.
        private Envelope _extentEnvelope;

        public SetMaxExtent()
        {
            InitializeComponent();
            Initialize();
        }

        private void Initialize()
        {
            // Create a new Map.
            Map myMap = new Map(BasemapStyle.ArcGISStreets);

            // Create an envelope for the map extent with points on Colorado's Northwest and Southeast corners.
            MapPoint northEastPoint = new MapPoint(-12139393.2109, 5012444.0468, SpatialReferences.WebMercator);
            MapPoint southWestPoint = new MapPoint(-11359277.5124, 4438148.7816, SpatialReferences.WebMercator);
            _extentEnvelope = new Envelope(northEastPoint, southWestPoint);

            // Create a graphics overlay of the map's max extent.
            GraphicsOverlay overlay = new GraphicsOverlay();

            // Create a simple red dashed line renderer.
            overlay.Renderer = new SimpleRenderer(new SimpleLineSymbol(style: SimpleLineSymbolStyle.Dash, color: System.Drawing.Color.Red, width: 5));

            // Set the graphic's geometry to the max extent of the map.
            overlay.Graphics.Add(new Graphic(_extentEnvelope));

            // Add the graphics overlay to the MapView.
            MyMapView.GraphicsOverlays.Add(overlay);

            // Create an initial viewpoint from the extent.
            Viewpoint initialViewpoint = new Viewpoint(_extentEnvelope);
            myMap.InitialViewpoint = initialViewpoint;

            // Assign the map to the MapView.
            MyMapView.Map = myMap;

            // Enable the max extent.
            MaxExtentCheckBox.IsChecked = true;
        }

        private void MaxExtentCheckBoxChanged(object sender, System.Windows.RoutedEventArgs e)
        {
            if (_extentEnvelope != null)
            {
                // Set the map max extent to null to disable the max extent or to the extentEnvelope to enable the max extent.
                MyMapView.Map.MaxExtent = MaxExtentCheckBox.IsChecked == true ? _extentEnvelope : null;
            }
        }
    }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.