Set max extent

View in

Forms

WPF

WinUI

View on GitHub

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

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

Relevant API

Envelope
Map

Sample Code

SetMaxExtent.xaml

SetMaxExtent.xaml.cs

Use dark colors for code blocksCopy
<UserControl x:Class="ArcGISRuntime.WinUI.Samples.SetMaxExtent.SetMaxExtent"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:esriUI="using:Esri.ArcGISRuntime.UI.Controls">
    <Grid>
        <esriUI:MapView x:Name="MyMapView" />
        <Border MaxWidth="200" Style="{StaticResource BorderStyle}">
            <CheckBox x:Name="MaxExtentCheckBox"
                      VerticalAlignment="Center"
                      VerticalContentAlignment="Center"
                      Checked="MaxExtentCheckBoxChanged"
                      Unchecked="MaxExtentCheckBoxChanged">
                <TextBlock Text="Max Extent Enabled" />
            </CheckBox>
        </Border>
    </Grid>
</UserControl>