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.
Prerequisites
The following are required for this tutorial:
An ArcGIS account to access your API keys. If you don't have an account, sign up for free.
To start the tutorial, complete the Display a map tutorial or download and unzip the solution.
Open the .xcodeproj file in Xcode.
If you downloaded the solution project, set your API key.
An API Key enables access to services, web maps, and web scenes hosted in ArcGIS Online.
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.
In Xcode, in the Project Navigator, click MainApp.swift.
In the Editor, set the ArcGISEnvironment.apiKey property on the ArcGISEnvironment with your API key.
The map will zoom to the extent 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.
A map view provides LocationDisplay for showing the current location of the device. The location symbol is displayed on top of all content in the map view.
Instances of this class manage the display of device location on a map view: the symbols, animation, auto pan behavior, and so on. Location display is an overlay of the map view, and displays above everything else, including graphics overlays.
The location display does not retrieve location information, that is the job of the associated data source, which provides location updates on a regular basis. In addition to the default system location data source, you can use location providers based on external GPS devices or a simulated location source.
Each map view has its own instance of a location display and instances of location display and location data source are not shared by multiple map views. This allows you to start and stop location display independently on multiple map views without affecting each other.
Start displaying the location by calling the data source's start() method.
If you are using the Xcode simulator your system must meet these minimum requirements: macOS Monterey 12.5, Xcode 14.0, iOS 16. If you are using a physical device, then refer to the system requirements.
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.
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.