Display a map (.NET MAUI)

Before starting this tutorial:

• You need an ArcGIS Location Platform or ArcGIS Online account.

• Ensure your development environment meets the system requirements.

Optionally, you may want to install the ArcGIS Maps SDK for .NET to get access to project templates in Visual Studio (Windows only) and offline copies of the NuGet packages.

Option 1: Develop the code

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 Multi-platform App UI (.NET MAUI). The instructions for this tutorial are specific to creating a .NET MAUI 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 .NET MAUI App template for C#. If you don't see the template listed, you can find it by typing MAUI 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 .NET 8 as framework you intend to target.
   • 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.Maui NuGet package.

   • Confirm the Latest stable version of the package is selected in the Version dropdown.

   • Click Apply.

   • 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.

   • Close the NuGet Package Manager window.

Correct minimum OS versions

The .NET MAUI App template may have operating system (OS) requirements below what ArcGIS Maps SDK for .NET requires for a .NET MAUI app. You must modify the minimum OS versions in your .csproj to satisfy the ArcGIS Maps SDK for .NET requirements.

1. In Visual Studio > Solution Explorer, double-click DisplayAMap to open the .csproj.

2. Modify the <SupportedOSPlatformVersion> properties in the <PropertyGroup> as shown below. This reflects the minimum OS requirements for ArcGIS Maps SDK for .NET MAUI for the current release.

   DisplayAMap.csproj

   Expand

   Use dark colors for code blocks

   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
   		<!-- Versions -->
   		<ApplicationDisplayVersion>1.0</ApplicationDisplayVersion>
   		<ApplicationVersion>1</ApplicationVersion>
   
   		<SupportedOSPlatformVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'ios'">15.0</SupportedOSPlatformVersion>
   		<SupportedOSPlatformVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'maccatalyst'">14.0</SupportedOSPlatformVersion>
   		<SupportedOSPlatformVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'android'">26.0</SupportedOSPlatformVersion>
   		<SupportedOSPlatformVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'windows'">10.0.19041.0</SupportedOSPlatformVersion>
   		<TargetPlatformMinVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'windows'">10.0.19041.0</TargetPlatformMinVersion>
   
   		<SupportedOSPlatformVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'tizen'">6.5</SupportedOSPlatformVersion>
   
   	</PropertyGroup>
   

   Expand
   Tizen code and resources

   The .NET MAUI App template includes Tizen as a platform. ArcGIS Maps SDK for .NET does not support Tizen, so feel free to remove Tizen code and resources from the solution. This step is optional, your project will work fine if you keep it as-is.

3. Save and close the .csproj file.

Set developer credentials

To allow your app users to access ArcGIS Location Services, use the developer credentials that you created in the Set up authentication step to authenticate requests for resources.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
  <!--https://github.com/dotnet/maui/issues/3760#issuecomment-1046241094-->

  <queries>
    <intent>
      <action android:name="android.support.customtabs.action.CustomTabsService" />
    </intent>
  </queries>

Remove default controls

The .NET MAUI App template provided by Visual Studio has default controls and logic. These must be removed to make room for the map view in your UI.

1. Open the MainPage.xaml file.

2. Remove the ScrollView container (and all the controls it contains) from the current UI.

   MainPage.xaml

   Use dark colors for code blocks

   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
   
   <ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
                xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
                x:Class="DisplayAMap.MainPage">
   
       <ScrollView>
           <VerticalStackLayout
               Spacing="25"
               Padding="30,0"
               VerticalOptions="Center">
   
               <Image
                   Source="dotnet_bot.png"
                   SemanticProperties.Description="Cute dot net bot waving hi to you!"
                   HeightRequest="200"
                   HorizontalOptions="Center" />
   
               <Label
                   Text="Hello, World!"
                   SemanticProperties.HeadingLevel="Level1"
                   FontSize="32"
                   HorizontalOptions="Center" />
   
               <Label
                   Text="Welcome to .NET Multi-platform App UI"
                   SemanticProperties.HeadingLevel="Level2"
                   SemanticProperties.Description="Welcome to dot net Multi platform App U I"
                   FontSize="18"
                   HorizontalOptions="Center" />
   
               <Button
                   x:Name="CounterBtn"
                   Text="Click me"
                   SemanticProperties.Hint="Counts the number of times you click"
                   Clicked="OnCounterClicked"
                   HorizontalOptions="Center" />
   
           </VerticalStackLayout>
       </ScrollView>
   
   </ContentPage>

3. Open the MainPage.xaml.cs file.

4. Remove the OnCounterClicked() function and the count variable.

   MainPage.xaml.cs

   Use dark colors for code blocks

   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
   
   namespace DisplayAMap;
   
   public partial class MainPage : ContentPage
   {
   
       int count = 0;
   
       public MainPage()
       {
           InitializeComponent();
       }
   
       private void OnCounterClicked(object sender, EventArgs e)
       {
           count++;
   
           if (count == 1)
               CounterBtn.Text = $"Clicked {count} time";
           else
               CounterBtn.Text = $"Clicked {count} times";
   
           SemanticScreenReader.Announce(CounterBtn.Text);
       }
   
   }

5. Save and close MainPage.xaml and MainPage.xaml.cs.

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.

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

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

3. Implement the INotifyPropertyChanged interface in the MapViewModel class.

   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

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

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

   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

   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
       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

   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
       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 => _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.

   MapViewModel.cs

   Expand

   Use dark colors for code blocks

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

   Expand

7. Add code to set the map's InitialViewpoint property to a Viewpoint.

   MapViewModel.cs

   Expand

   Use dark colors for code blocks

   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
               // Create a new map with a 'topographic vector' basemap.
               Map = new Map(BasemapStyle.ArcGISTopographic);
   
               var mapCenterPoint = new MapPoint(-118.805, 34.027, SpatialReferences.Wgs84);
               Map.InitialViewpoint = new Viewpoint(mapCenterPoint, 100000);
   

   Expand

8. Add a constructor to the class that calls SetupMap() when a new MapViewModel is instantiated.

   Class constructors

   When you write code like MapViewModel newMapVM = new MapViewModel(); to create a new instance, the class constructor is called. This is a good place to add code to set default values for properties and perform other setup tasks.

   MapViewModel.cs

   Expand

   Use dark colors for code blocks

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

   Expand

9. Save and close the MapViewModel.cs file.

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 in the MapViewModel.

1. Add required XML namespace and resource declarations to MainPage.xaml.

   Details

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

   Expand

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   <ContentPage x:Class="DisplayAMap.MainPage"
                xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
                xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
                xmlns:esri="http://schemas.esri.com/arcgis/runtime/2013"
                xmlns:local="clr-namespace:DisplayAMap">
   
       <ContentPage.Resources>
           <local:MapViewModel x:Key="MapViewModel" />
       </ContentPage.Resources>
   

   Expand

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

   Details

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

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   <?xml version="1.0" encoding="utf-8" ?>
   
   <ContentPage x:Class="DisplayAMap.MainPage"
                xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
                xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
                xmlns:esri="http://schemas.esri.com/arcgis/runtime/2013"
                xmlns:local="clr-namespace:DisplayAMap">
   
       <ContentPage.Resources>
           <local:MapViewModel x:Key="MapViewModel" />
       </ContentPage.Resources>
   
   
       <esri:MapView x:Name="MainMapView" Map="{Binding Map, Source={StaticResource MapViewModel}}" />
   
   </ContentPage>

3. Save and close the MainPage.xaml file.

Run the app

Click Debug > Start Debugging (or press <F5> on the keyboard) to run the app. If your app uses user authentication, enter your ArcGIS Online credentials when prompted.

Deploy the app to a Windows, Mac, iOS, or Android device. You will see a map with the topographic basemap layer centered on the Santa Monica Mountains in California. Pan and zoom with mouse or touchscreen controls to explore the map.

Option 2: Download the solution

1. Click the Download solution link in the right-hand panel of the page.

2. Unzip the file to a location on your machine.

3. Open the .sln file in Visual Studio.

Since the downloaded solution does not contain authentication credentials, you must add the developer credentials that you created in the set up authentication section.

Set developer credentials in the solution

To allow your app users to access ArcGIS location services, use the developer credentials that you created in the Set up authentication step to authenticate requests for resources.

Run the app

Click Debug > Start Debugging (or press <F5> on the keyboard) to run the app. If your app uses user authentication, enter your ArcGIS Online credentials when prompted.

Deploy the app to a Windows, Mac, iOS, or Android device. You will see a map with the topographic basemap layer centered on the Santa Monica Mountains in California. Pan and zoom with mouse or touchscreen controls to explore the map.