Display a map

Learn how to create and display a map with a basemap layer.

A map contains layers of geographic data. A map contains a basemap layer and, optionally, one or more data layers. You can display a specific area of a map by using a map view and setting the location and zoom level.

In this tutorial, you create and display a map of the Santa Monica Mountains in California using the topographic basemap layer.

The map and code will be used as the starting point for other 2D tutorials.

Prerequisites

Steps

Create a new Visual Studio Project

ArcGIS Maps SDK for .NET supports apps for Windows Presentation Framework (WPF), Universal Windows Platform (UWP), Windows UI Library (WinUI), and .NET MAUI. The instructions for this tutorial are specific to creating a .NET 6 WPF project using Visual Studio for Windows.

1. Start Visual Studio and create a new project.

   • In the Visual Studio start screen, click Create a new project.
   • Choose the WPF Application template for C#. If you don't see the template listed, you can find it by typing WPF Application into the Search for templates text box.
   • Click Next.
   • Provide required values in the Configure your new project panel:
     • Project name: DisplayAMap
     • Location: choose a folder
   • Click Next.
     • Choose the framework: .NET 6.0 (Long Term Support)
   • Click Create to create the project.

Add a reference to the API

1. Add a reference to the API by installing a NuGet package.

   • In Solution Explorer, right-click Dependencies and choose Manage NuGet Packages.
   • In the NuGet Package Manager window, ensure the selected Package source is nuget.org (upper-right).
   • Select the Browse tab and search for ArcGIS Maps SDK.
   • In the search results, select the appropriate package for your platform. For this tutorial project, choose the Esri.ArcGISRuntime.WPF NuGet package.
   • Confirm the Latest stable version of the package is selected in the Version dropdown.
   • Click Install.
   • The Preview Changes dialog confirms any package(s) dependencies or conflicts. Review the changes and click OK to continue installing the packages.
   • Review the license information on the License Acceptance dialog and click I Accept to add the package(s) to your project.
   • In the Visual Studio Output window, ensure the packages were successfully installed. If you see an error about the target Windows version, you will fix that in the next step.
   • Close the NuGet Package Manager window.

2. You may see an error like this in the Visual Studio Error List: The 'Esri.ArcGISRuntime.WPF' nuget package cannot be used to target 'net6.0-windows'. Target 'net6.0-windows10.0.19041.0' or later instead.. If so, follow these steps to address it.

   • In Solution Explorer, right-click the DisplayAMap project entry in the tree view and choose Edit Project File.

   • Update the <TargetFramework> element with net6.0-windows10.0.19041.0 (or higher).

     Use dark colors for code blocks

          

     Change line

     1
     2
     3
     4
     5
     <PropertyGroup>
       <OutputType>WinExe</OutputType>
       <TargetFramework>net6.0-windows10.0.19041.0</TargetFramework>
       <UseWPF>true</UseWPF>
     </PropertyGroup>

   • Save the project file (DisplayAMap) and close it.

Get an API key

An API key is required to enable access to services, web maps, and web scenes hosted in ArcGIS Online.

If you haven't already, go to your developer dashboard to get your API key. For these tutorials, use your default API key. It is scoped to include all of the services demonstrated in the tutorials.

You will use this API Key below.

Set the API Key in your app

1. In the Solution Explorer, expand the node for App.xaml, and double-click App.xaml.cs to open it.

2. In the App class, add an override for the OnStartup() function to set the ApiKey property on ArcGISRuntimeEnvironment.

   App.xaml.cs

   Expand

   Use dark colors for code blocks

                                           

   Add line.Add line.Add line.Add line.Add line.Add line.Add line.

   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
       public partial class App : Application
       {
   
           protected override void OnStartup(StartupEventArgs e)
           {
               base.OnStartup(e);
               // Note: it is not best practice to store API keys in source code.
               // The API key is referenced here for the convenience of this tutorial.
               Esri.ArcGISRuntime.ArcGISRuntimeEnvironment.ApiKey = "YOUR_API_KEY";
           }
   
       }
   }

3. Save and close the App.xaml.cs file.

Create a view model to store app logic

This app is the foundation for many following tutorials so it's good to build it with a solid design.

The Model-View-ViewModel (MVVM) design pattern provides an architecture that separates user interface elements (and related code) from the underlying app logic. In this pattern, the model represents the data consumed in an app, the view is the user interface, and the view model contains the logic that binds the models and views together. The extra framework required for such a pattern might seem like a lot of work for a small project, but as the complexity of your project grows, a solid design can make your code much more maintainable and flexible.

In an ArcGIS app designed with MVVM, the map view usually provides the main view component. Many of the classes fill the role of models (representing data as maps, layers, graphics, features, and others). Much of the code you write will be for the view model component, since this is where you will add logic to work with ArcGIS objects and provide data for display in the view.

1. Add a new class that will define a view model for the project.

   • Click Project > Add Class ....
   • Name the new class MapViewModel.cs.
   • Click Add to create the new class and add it to the project.
   • The new class will open in Visual Studio.

2. Add required using statements to the view model.

   MapViewModel.cs

   Use dark colors for code blocks

                                                                 

   Add line.Add line.Add line.

   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
   using System;
   using System.Collections.Generic;
   using System.Linq;
   using System.Text;
   using System.Threading.Tasks;
   
   using Esri.ArcGISRuntime.Mapping;
   using System.ComponentModel;
   using System.Runtime.CompilerServices;
   

3. Implement the INotifyPropertyChanged interface in the MapViewModel class.

   More info

   This interface defines a PropertyChanged event that is used to notify clients (views) that a property of the view model has changed.

   MapViewModel.cs

   Use dark colors for code blocks

                                                                 

   Change lineChange line

   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
   namespace DisplayAMap
   {
   
       internal class MapViewModel : INotifyPropertyChanged
       {
   

4. Inside the MapViewModel class, add code to implement the PropertyChanged event.

   More info

   When a property of the view model changes, a call to OnPropertyChanged will raise this event.

   MapViewModel.cs

   Expand

   Use dark colors for code blocks

                                                                 

   Add line.Add line.Add line.Add line.Add line.

   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
       internal class MapViewModel : INotifyPropertyChanged
       {
   
           public event PropertyChangedEventHandler? PropertyChanged;
           protected void OnPropertyChanged([CallerMemberName] string propertyName = "")
           {
               PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
           }
   
       }
   

   Expand

5. Define a new property on the view model called Map that exposes a Map object. When the property is set, call OnPropertyChanged.

   MapViewModel.cs

   Expand

   Use dark colors for code blocks

                                                                 

   Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.

   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
       internal class MapViewModel : INotifyPropertyChanged
       {
   
           public event PropertyChangedEventHandler? PropertyChanged;
           protected void OnPropertyChanged([CallerMemberName] string propertyName = "")
           {
               PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
           }
   
           private Map? _map;
           public Map? Map
           {
               get { return _map; }
               set
               {
                   _map = value;
                   OnPropertyChanged();
               }
           }
   
       }
   

   Expand

6. Add a function to the MapViewModel class called SetupMap. This function will create a new map and use it to set the Map property.

   More info

   The map will use a topographic vector tiled basemap.

   MapViewModel.cs

   Expand

   Use dark colors for code blocks

                                                                 

   Add line.Add line.Add line.Add line.Add line.Add line.Add line.

   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
           private void SetupMap()
           {
   
               // Create a new map with a 'topographic vector' basemap.
               Map = new Map(BasemapStyle.ArcGISTopographic);
   
           }
   

   Expand

7. Add a constructor to the class that calls SetupMap when a new MapViewModel is instantiated.

   More info

   When you write code like MapViewModel newMapVM = new MapViewModel();, the class constructor runs. This is a good place to add code that needs to run when the class is initialized.

   MapViewModel.cs

   Expand

   Use dark colors for code blocks

                                                                 

   Add line.Add line.Add line.Add line.

   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
   namespace DisplayAMap
   {
   
       internal class MapViewModel : INotifyPropertyChanged
       {
   
           public MapViewModel()
           {
               SetupMap();
           }
   

   Expand

Your MapViewModel is complete!

An advantage of using the MVVM design pattern is the ability to reuse code in a view model. Because this API has a nearly-standard API surface across platforms, a view model written for one app typically works on all supported .NET platforms.

Next, you will set up a view in your project to consume the view model.

Add a map view

A MapView control is used to display a map. You will add a map view to your project UI and wire it up to consume the map that is defined on MapViewModel.

1. Add required XML namespace and resource declarations.

   More info

   • Open MainWindow.xaml and switch to the XAML view
   • Inside the existing namespace declarations, add an esri XML namespace for the ArcGIS controls
   • Add XAML that defines a MapViewModel instance as a static resource
   MainWindow.xaml

   Use dark colors for code blocks

                          

   Add line.Add line.Add line.Add line.

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   
   <Window x:Class="DisplayAMap.MainWindow"
           xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
           xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
           xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
           xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
           xmlns:local="clr-namespace:DisplayAMap"
           xmlns:esri="http://schemas.esri.com/arcgis/runtime/2013"
           mc:Ignorable="d"
           Title="MainWindow" Height="450" Width="800">
   
       <Window.Resources>
           <local:MapViewModel x:Key="MapViewModel" />
       </Window.Resources>
   

   Expand

2. Add a MapView control to MainWindow.xaml and bind it to the MapViewModel.

   More info

   • Add XAML that defines a MapView control named MainMapView
   • Use data binding to set the Map property of the control using the MapViewModel resource.
   MainWindow.xaml

   Expand

   Use dark colors for code blocks

                          

   Add line.Add line.

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
       <Grid>
   
           <esri:MapView x:Name="MainMapView"
                         Map="{Binding Map, Source={StaticResource MapViewModel}}" />
   
       </Grid>
   

   Expand

Set a viewpoint on the map view

Set a viewpoint for the map view when the window loads. The viewpoint defines a point and map scale that centers the display on the Santa Monica mountains along the coast of southern California.

1. Open MainWindow.xaml.cs. This is the code behind file that contains code associated with MainWindow.xaml and the user interface element it defines.

2. Add new required usings:

   MainWindow.xaml.cs

   Expand

   Use dark colors for code blocks

                                                     

   Add line.Add line.

   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
   using System;
   using System.Collections.Generic;
   using System.Linq;
   using System.Text;
   using System.Threading.Tasks;
   using System.Windows;
   using System.Windows.Controls;
   using System.Windows.Data;
   using System.Windows.Documents;
   using System.Windows.Input;
   using System.Windows.Media;
   using System.Windows.Media.Imaging;
   using System.Windows.Navigation;
   using System.Windows.Shapes;
   
   using Esri.ArcGISRuntime.Geometry;
   using Esri.ArcGISRuntime.Mapping;
   

   Expand

3. In the constructor for MainWindow, add code to define a new Viewpoint and apply it to the map view.

   MainWindow.xaml.cs

   Expand

   Use dark colors for code blocks

                                                     

   Add line.Add line.

   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
           public MainWindow()
           {
               InitializeComponent();
   
               MapPoint mapCenterPoint = new MapPoint(-118.805, 34.027, SpatialReferences.Wgs84);
               MainMapView.SetViewpoint(new Viewpoint(mapCenterPoint, 100000));
   
           }
   

   Expand

Run the app

Click Debug > Start Debugging (or press <F5> on the keyboard) to run the app.

You should see a map with the topographic basemap layer centered on the Santa Monica Mountains in California. Double-click, drag, and scroll the mouse wheel over the map view to explore the map.

What's next?

Learn how to use additional API features, ArcGIS location services, and ArcGIS tools in these tutorials:

• Display a web map
• Add a point, line, and polygon
• Display a scene
• Add a feature layer