Display Device Location

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

display device location

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.

Prerequisites

Before starting this tutorial:

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

  2. Your system meets the system requirements.

Develop or Download

To complete this tutorial you have 2 options:

  1. Option 1: Develop the code or
  2. Option 2: Download the completed solution

Option 1: Develop the code

To start the tutorial, complete the Display a map tutorial. This creates a map to display the Santa Monica Mountains in California using the topographic basemap from the . You can choose to implement either or .

Continue with the following instructions to display the current device location on a map or scene.

Add a custom iOS target property

The app must provide a message that tells the user why the app is requesting access to the user's location when the app is in use.

  1. In Xcode, in the Project navigator, select the target app.

  2. Click the Info tab and add the "Privacy - Location When In Use Usage Description" key under Custom iOS Target Properties.

  3. Add a string value describing how the app would use the device location. For example, "Your location is used to show your position on the map."

Import Core Location

  1. In Xcode, in the Project Navigator, click ContentView.swift.

  2. In the Editor, import the CoreLocation framework. This is required to request the user's location.

    ContentView.swift
    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
    import ArcGIS
    
    import CoreLocation
    

Initialize the map

  1. The map will zoom to the of the current location, so you don't need to set the viewpoint anymore. Remove the map StateObject and replace it with just a map initializer.

    ContentView.swift
    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
    struct ContentView: View {
    
        private let map = Map(basemapStyle: .arcGISTopographic)
    
    

Add location display to map view

  1. Create the location display using the system location data source.

    ContentView.swift
    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
    struct ContentView: View {
    
        private let map = Map(basemapStyle: .arcGISTopographic)
    
        private let locationDisplay = LocationDisplay(dataSource: SystemLocationDataSource())
    
    
  2. Add the location display modifier to the map view.

    ContentView.swift
    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
        var body: some View {
            MapView(map: map)
    
                .locationDisplay(locationDisplay)
    
                }
    
        }
    

Request user authorization to use location

The app must request authorization from the user to access the device location. The user can grant or deny the request.

  1. In the task modifier, create a CLLocationManager.

  2. If the authorization status is not determined, request "in use authorization".

    ContentView.swift
    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
        var body: some View {
            MapView(map: map)
    
                .locationDisplay(locationDisplay)
    
                .task {
                    let locationManager = CLLocationManager()
                    if locationManager.authorizationStatus == .notDetermined {
                        locationManager.requestWhenInUseAuthorization()
                    }
    
                }
    
        }
    

Show the current location

A provides LocationDisplay for showing the current location of the . The location symbol is displayed on top of all content in the map view.

  1. Start displaying the location by calling the data source's start() method.

    ContentView.swift
    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
        var body: some View {
            MapView(map: map)
    
                .locationDisplay(locationDisplay)
    
                .task {
                    let locationManager = CLLocationManager()
                    if locationManager.authorizationStatus == .notDetermined {
                        locationManager.requestWhenInUseAuthorization()
                    }
    
                    do {
                        try await locationDisplay.dataSource.start()
    
                    } catch {
    
                    }
    
                }
    
        }
    
  2. Set the initial zoom scale and the auto pan mode.

    ContentView.swift
    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
        var body: some View {
            MapView(map: map)
    
                .locationDisplay(locationDisplay)
    
                .task {
                    let locationManager = CLLocationManager()
                    if locationManager.authorizationStatus == .notDetermined {
                        locationManager.requestWhenInUseAuthorization()
                    }
    
                    do {
                        try await locationDisplay.dataSource.start()
    
                        locationDisplay.initialZoomScale = 40_000
                        locationDisplay.autoPanMode = .recenter
    
                    } catch {
    
                    }
    
                }
    
        }
    

Error handling

  1. Add a Bool called failedToStart.

    ContentView.swift
    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
    struct ContentView: View {
    
        private let map = Map(basemapStyle: .arcGISTopographic)
    
        private let locationDisplay = LocationDisplay(dataSource: SystemLocationDataSource())
    
        @State private var failedToStart = false
    
  2. In the catch closure, set the failedToStart boolean to true. If the location display fails to start, the value will be changed.

    ContentView.swift
    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
                    do {
                        try await locationDisplay.dataSource.start()
    
                        locationDisplay.initialZoomScale = 40_000
                        locationDisplay.autoPanMode = .recenter
    
                    } catch {
    
                        self.failedToStart = true
    
                    }
    
  3. Present an alert if the location display failed to start.

    ContentView.swift
    Expand
    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
        var body: some View {
            MapView(map: map)
    
                .locationDisplay(locationDisplay)
    
                .task {
                    let locationManager = CLLocationManager()
                    if locationManager.authorizationStatus == .notDetermined {
                        locationManager.requestWhenInUseAuthorization()
                    }
    
                    do {
                        try await locationDisplay.dataSource.start()
    
                        locationDisplay.initialZoomScale = 40_000
                        locationDisplay.autoPanMode = .recenter
    
                    } catch {
    
                        self.failedToStart = true
    
                    }
    
                }
    
                .alert("Location display failed to start", isPresented: $failedToStart) {}
    
        }
    
    Expand

Run the solution

  1. Press Command + R to run the app.

  2. When the app runs, you'll see the system prompt requesting to use the device location. Tap to either Allow once or While using the app.

  3. If the app is running on a simulator, you'll have to provide a simulated location. Go to the Features menu of the Simulator. Under Location, choose a predefined option or enter a custom Location.

Your map should now show the device's location, either simulated or actual.

Alternatively, you can download the tutorial solution, as follows.

Option 2: Download the solution

  1. Click the Download solution link under Solution and unzip the file to a location on your machine.

  2. Open the .xcodeproj file in Xcode.

Since the downloaded solution does not contain authentication credentials, you must first set up authentication to create credentials, and then add the developer credentials to the solution.

Set up authentication

To access the secure used in this tutorial, you must implement or using an or an account.

Create a new API key with to access the secure resources used in this tutorial.

  1. Complete the Create an API key tutorial and create an API key with the following :

    • Privileges
      • Location services > Basemaps
  2. Copy and paste the API Key access token into a safe location. It will be used in a later step.

Set developer credentials in the solution

To allow your app users to access , pass the developer credentials that you created in the Set up authentication step to the application's ArcGISEnvironment.

Pass your API Key access token to the ArcGISEnvironment.

  1. In the Project Navigator, click MainApp.swift.

  2. Set the AuthenticationMode to .apiKey.

    MainApp.swift
    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
    78
    79
        // Change the `AuthenticationMode` to `.apiKey` if your application uses API key authentication.
    
        private var authenticationMode: AuthenticationMode { .apiKey }
    
    
  3. Set the apiKey property with your API key access token.

    MainApp.swift
    Expand
    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
    78
    79
        // Please enter an API key access token if your application uses API key authentication.
    
        private let apiKey = APIKey("<#YOUR-ACCESS-TOKEN#>")
    
    
    Expand

Best Practice: The access token is stored directly in the code as a convenience for this tutorial. In a production environment we do not recommend that you store it directly in source code.

Run the solution

  1. Press Command + R to run the app.

  2. When the app runs, you'll see the system prompt requesting to use the device location. Tap to either Allow once or While using the app.

  3. If the app is running on a simulator, you'll have to provide a simulated location. Go to the Features menu of the Simulator. Under Location, choose a predefined option or enter a custom Location.

Your map should now show the device's location, either simulated or actual.

What's next?

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

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close