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

   29 collapsed lines
   <Project Sdk="Microsoft.NET.Sdk">
   
     <PropertyGroup>
       <TargetFrameworks>net9.0-android;net9.0-ios;net9.0-maccatalyst</TargetFrameworks>
       <TargetFrameworks Condition="$([MSBuild]::IsOSPlatform('windows'))">$(TargetFrameworks);net9.0-windows10.0.19041.0</TargetFrameworks>
       <!-- Uncomment to also build the tizen app. You will need to install tizen by following this: https://github.com/Samsung/Tizen.NET -->
       <!-- <TargetFrameworks>$(TargetFrameworks);net8.0-tizen</TargetFrameworks> -->
   
       <!-- Note for MacCatalyst:
       The default runtime is maccatalyst-x64, except in Release config, in which case the default is maccatalyst-x64;maccatalyst-arm64.
       When specifying both architectures, use the plural <RuntimeIdentifiers> instead of the singular <RuntimeIdentifier>.
       The Mac App Store will NOT accept apps with ONLY maccatalyst-arm64 indicated;
       either BOTH runtimes must be indicated or ONLY macatalyst-x64. -->
       <!-- For example: <RuntimeIdentifiers>maccatalyst-x64;maccatalyst-arm64</RuntimeIdentifiers> -->
   
       <OutputType>Exe</OutputType>
       <RootNamespace>DisplayAMap</RootNamespace>
       <UseMaui>true</UseMaui>
       <SingleProject>true</SingleProject>
       <ImplicitUsings>enable</ImplicitUsings>
       <Nullable>enable</Nullable>
   
       <!-- Display name -->
       <ApplicationTitle>DisplayAMap</ApplicationTitle>
   
       <!-- App Identifier -->
       <ApplicationId>com.companyname.displayamap</ApplicationId>
       <ApplicationIdGuid>8861a28a-1665-4549-825a-f7c5ee7dac07</ApplicationIdGuid>
   
       <!-- Versions -->
       <ApplicationDisplayVersion>1.0</ApplicationDisplayVersion>
       <ApplicationVersion>1</ApplicationVersion>
   
       <SupportedOSPlatformVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'ios'">16.0</SupportedOSPlatformVersion>
       <SupportedOSPlatformVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'maccatalyst'">14.0</SupportedOSPlatformVersion>
       <SupportedOSPlatformVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'android'">28.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>
   32 collapsed lines
   
   
     <ItemGroup>
       <!-- App Icon -->
       <MauiIcon Include="Resources\AppIcon\appicon.svg" ForegroundFile="Resources\AppIcon\appiconfg.svg" Color="#512BD4" />
   
       <!-- Splash Screen -->
       <MauiSplashScreen Include="Resources\Splash\splash.svg" Color="#512BD4" BaseSize="128,128" />
   
       <!-- Images -->
       <MauiImage Include="Resources\Images\*" />
       <MauiImage Update="Resources\Images\dotnet_bot.png" Resize="True" BaseSize="300,185" />
   
       <!-- Custom Fonts -->
       <MauiFont Include="Resources\Fonts\*" />
   
       <!-- Raw Assets (also remove the "Resources\Raw" prefix) -->
       <MauiAsset Include="Resources\Raw\**" LogicalName="%(RecursiveDir)%(Filename)%(Extension)" />
     </ItemGroup>
   
     <ItemGroup>
       <PackageReference Include="Microsoft.Maui.Controls" Version="9.0.50" />
       <PackageReference Include="Microsoft.Maui.Controls.Compatibility" Version="9.0.50" />
       <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="9.0.3" />
       <PackageReference Include="Esri.ArcGISRuntime.Maui" Version="200.8.2" />
     </ItemGroup>
   
     <ItemGroup Condition="'$(TargetFramework)' == 'net9.0-windows10.0.19041.0'">
       <PackageReference Include="WinUIEx" Version="2.6.0" />
     </ItemGroup>
   
   </Project>
   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 ArcGIS Location Services, also referred to as Location Services, are services hosted by Esri that provide geospatial functionality for developing mapping applications. They include the ArcGIS Basemap Styles service, ArcGIS Static Basemap Tiles service, ArcGIS Places service, ArcGIS Geocoding service, ArcGIS Routing service, ArcGIS GeoEnrichment service, and ArcGIS Elevation service. An ArcGIS Location Platform or ArcGIS Online account is required to use the services. Learn more , use the developer credentials that you created in the Set up authentication step to authenticate requests for resources.

6 collapsed lines
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
  <application android:allowBackup="true" android:icon="@mipmap/appicon" android:roundIcon="@mipmap/appicon_round" android:supportsRtl="true"></application>
  <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
  <uses-permission android:name="android.permission.INTERNET" />

  <!--https://github.com/dotnet/maui/issues/3760#issuecomment-1046241094-->

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

</manifest>

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

   <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

   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

   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

   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

   28 collapsed lines
   //   Copyright 2023 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
   //
   //   https://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 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;
   
   namespace DisplayAMap
   {
   
       internal class MapViewModel : INotifyPropertyChanged
       {
   
           public event PropertyChangedEventHandler? PropertyChanged;
           protected void OnPropertyChanged([CallerMemberName] string propertyName = "")
           {
               PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
           }
   
       }
   2 collapsed lines
   
   }

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

   28 collapsed lines
   //   Copyright 2023 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
   //
   //   https://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 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;
   
   namespace DisplayAMap
   {
   
       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();
               }
           }
   
       }
   2 collapsed lines
   
   }

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

   48 collapsed lines
   //   Copyright 2023 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
   //
   //   https://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 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;
   
   namespace DisplayAMap
   {
   
       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();
               }
           }
   
           private void SetupMap()
           {
   
               // Create a new map with a 'topographic vector' basemap.
               Map = new Map(BasemapStyle.ArcGISTopographic);
   
           }
   4 collapsed lines
   
       }
   
   }

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

   MapViewModel.cs

   51 collapsed lines
   //   Copyright 2023 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
   //
   //   https://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 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;
   
   namespace DisplayAMap
   {
   
       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();
               }
           }
   
           private void SetupMap()
           {
   
               // 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);
   6 collapsed lines
   
           }
   
       }
   
   }

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

   25 collapsed lines
   //   Copyright 2023 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
   //
   //   https://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 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;
   
   namespace DisplayAMap
   {
   
       internal class MapViewModel : INotifyPropertyChanged
       {
   
           public MapViewModel()
           {
               SetupMap();
           }
   32 collapsed lines
   
           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();
               }
           }
   
           private void SetupMap()
           {
   
               // 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);
   
           }
   
       }
   
   }

9. Save and close the MapViewModel.cs file.