Display device location (.NET MAUI)

Learn how to display the current device location on a map or scene.

You can display the device location on a map or scene. This is important for workflows that require the user's current location, such as finding nearby businesses, navigating from the current location, or identifying and collecting geospatial information.

By default, location display uses the device's location provider. Your app can also process input from other location providers, such as an external GPS receiver or a provider that returns a simulated location. For more information, see the Show device location topic.

This tutorial builds a cross-platform app using the .NET Multi-platform App UI (.NET MAUI) framework. .NET MAUI allows you to build native cross-platform apps from a shared code base. If you'd prefer to build this app as a Windows desktop app, see the Windows Presentation Foundation (WPF) version of this tutorial.

Prerequisites

Steps

Open a Visual Studio solution

1. To start the tutorial, complete the Display a map (.NET MAUI) tutorial or download and unzip the solution.

2. Open the .sln file in Visual Studio.

3. If you downloaded the solution, get an access token and set the API key.
   Instructions for setting the API key

   An API Key gives your app access to secure resources used in this tutorial.

   If necessary, set the  API Key.

   1. Go to the Create an API key tutorial to obtain a new API key access token. Ensure that the following privilege is enabled: Location services > Basemaps > Basemap styles service. Copy the access token as it will be used in the next step.

   2. In the Solution Explorer, open MauiProgram.cs by double-clicking.

   3. Use the existing builder variable in the CreateMauiApp() function to call UseArcGISRuntime(). Use a lambda function to call UseApiKey() on a config parameter to set the ApiKey property on ArcGISRuntimeEnvironment.

      MauiProgram.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
      public static class MauiProgram
      {
          public static MauiApp CreateMauiApp()
      	{
      		var builder = MauiApp.CreateBuilder();
      		builder
      			.UseMauiApp<App>()
      			.ConfigureFonts(fonts =>
      			{
      				fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
      				fonts.AddFont("OpenSans-Semibold.ttf", "OpenSansSemibold");
                  });
      
      		builder.UseArcGISRuntime(config => config.UseApiKey("YOUR_ACCESS_TOKEN"));
      
      #if DEBUG
              builder.Logging.AddDebug();
      #endif
      
      		return builder.Build();
      	}
      }

   4. Save and close the MauiProgram.cs file.

Update the tutorial name used in the project (optional)

The Visual Studio solution, project, and the namespace for all classes currently use the name DisplayAMap. Follow the steps below if you prefer the name to reflect the current tutorial. These steps are not required, your code will still work if you keep the original name.

Android location permissions

Android apps do not have access to location information by default. In the app manifest, you must add properties to request location permissions.

1. In the Visual Studio > Solution Explorer, navigate to the Platforms\Android folder.

2. Click AndroidManifest.xml to open the manifest editor.

3. In the Required permissions section, check ACCESS_COARSE_LOCATION and ACCESS_FINE_LOCATION.

4. Save and close AndroidManifest.xml.

iOS and MacOS location permissions

iOS and MacOS prevent apps from accessing location information until the user grants permission. In the Information Property List, you must add a key-value pair to request authorization to use location services.

1. In the Visual Studio > Solution Explorer, navigate to Platforms\iOS.

2. Right-click Info.plist. Click Open With.. from the context menu and select Automatic Editor Selector (XML). Click OK to open the file.

3. Add the required key-value pair.

   Info.plist

   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
   	<key>XSAppIconAssets</key>
   	<string>Assets.xcassets/appicon.appiconset</string>
   
   	<key>NSLocationWhenInUseUsageDescription</key>
   	<string>Your location is displayed on the map.</string>
   
   </dict>
   </plist>

4. Save and close Info.plist.

5. Repeat steps 2-4, this time modifying the Info.plist file in the Platforms\MacCatalyst folder.

Show the current location

Each map view has its own instance of a LocationDisplay for showing the current location (point) of the device. The location is displayed as an overlay in the map view.

1. In the Visual Studio > Solution Explorer, double-click MapViewModel.cs to open the file.

2. Remove code from the SetupMap() function that sets the map's InitialViewpoint. The map will zoom to the extent of the current location, so this code is no longer needed.

   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
           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);
   
           }
   

3. Save and close the MapViewModel.cs file.

4. In the Visual Studio > Solution Explorer, double-click MainPage.xaml.cs to open the file.

5. Add using statements at the top of the file, after the namespace declaration.

   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
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   using Esri.ArcGISRuntime.UI;
   using System.ComponentModel;
   

6. Add a new function DisplayDeviceLocationAsync below the constructor.

   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
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
       private async Task DisplayDeviceLocationAsync()
       {
   
       }
   

7. Add code to DisplayDeviceLocationAsync() that requests access to location.

   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
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
       private async Task DisplayDeviceLocationAsync()
       {
   
           PermissionStatus status = await Permissions.RequestAsync<Permissions.LocationWhenInUse>();
   
       }
   

8. Add code to DisplayDeviceLocationAsync() that enables the LocationDisplay for the map view if permission was granted. Assign a LocationDisplayAutoPanMode that centers the map at the device location.

   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
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
       private async Task DisplayDeviceLocationAsync()
       {
   
           PermissionStatus status = await Permissions.RequestAsync<Permissions.LocationWhenInUse>();
   
           MainMapView.LocationDisplay.IsEnabled = status == PermissionStatus.Granted || status == PermissionStatus.Restricted;
           MainMapView.LocationDisplay.AutoPanMode = LocationDisplayAutoPanMode.Recenter;
   
       }
   

9. In the MainPage constructor, add code to subscribe to the PropertyChanged event of the map view. If LocationDisplay is the property being changed, call DisplayDeviceLocationAsync().

   MainPage.xaml.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
           MainMapView.PropertyChanged += (object sender, PropertyChangedEventArgs e) =>
           {
               // The map view's location display is initially null, so check for a location display property change before enabling it.
               if (e.PropertyName == nameof(LocationDisplay))
               {
                   _ = DisplayDeviceLocationAsync();
               }
           };
   

   Expand

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

    More info

    If creating apps for Android or iOS, you will need the appropriate emulator, simulator, or device configured for testing (see System requirements for details)

Deploy the app to a Windows, Mac, iOS, or Android device. Allow the app to access your precise location if prompted. You will see your device's current location displayed on the map. Different location symbols are used depending on the auto pan mode and whether a location is acquired. See LocationDisplayAutoPanMode for details.

What's next?

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

• Search for an address
• Find a route and directions