Display a map

Learn how to create and display a map with a basemap layer.

Overview of how to display a map

A map contains layers of geographic data. A map contains a basemap layer and, optionally, one or more data layers. You can display a specific area of a map by using a map view and setting the location and zoom level.

In this tutorial, you create and display a map of the Santa Monica Mountains in California using the topographic basemap layer.

The map and code will be used as the starting point for other 2D tutorials.

Prerequisites

Before starting this tutorial:

You need an ArcGIS Location Platform or ArcGIS Online account.
Your system meets the system requirements.

Set up authentication

To access the secure ArcGIS location services used in this tutorial, you must implement API key authentication or user authentication using an ArcGIS Location Platform or an ArcGIS Online account.

You can implement API key authentication or user authentication in this tutorial. Compare the differences below:

API key authentication

Users are not required to sign in.
Requires creating an API key credential with the correct privileges.
API keys are long-lived access tokens.
Service usage is billed to the API key owner/developer.
Simplest authentication method to implement.
Recommended approach for new ArcGIS developers.

Learn more in API key authentication.

User authentication

Users are required to sign in with an ArcGIS account.
User accounts must have privilege to access the ArcGIS services used in application.
Requires creating OAuth credentials.
Application uses a redirect URL and client ID.
Service usage is billed to the organization of the user signed into the application.

Learn more in User authentication.

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

Complete the Create an API key tutorial and create an API key with the following privilege(s):
- Privileges
  - Location services > Basemaps
Copy and paste the API Key access token into a safe location. It will be used in a later step.

Develop or Download

To complete this tutorial you have 2 options:

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

Option 1: Develop the code

Create a new app

To get started, use Xcode to create an iOS app and configure it to reference the API.

Open Xcode. In the menu bar, click File > New > Project.
- In the Choose a template for your new project: window, set the following properties:
  - Multiplatform iOS
  - Application App
- Click Next.
- In the Choose options for your new project: window, set the following properties:
  - Product Name: <your app name>
  - Organization Identifier: <your organization>
  - Interface: SwiftUI
  - Language: Swift
- Uncheck all other options.
- Click Next.
- Choose a location to store your project. Click Create.
In the Project Navigator, click <your app name>App. In the Editor, right click on the struct name, <your app name>App. Select Refactor > Rename... to rename the struct to MainApp. Click the Rename button in the top right to confirm the new name. This will rename the struct and file in all affected areas. This file and struct will be named MainApp for all the subsequent tutorials.
Add a reference to the API using Swift Package Manager.

Set developer credentials

To allow your app users to access ArcGIS location services, 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.

In the Project Navigator, click MainApp.swift.

Implement an initializer in the MainApp struct and set the ArcGISEnvironment.apiKey property with your API key access token.

MainApp.swift
Use dark colors for code blocks

import SwiftUI

import ArcGIS

@main
struct MainApp: App {

    init() {

        ArcGISEnvironment.apiKey = APIKey("<#YOUR-ACCESS-TOKEN#>")

    }

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.

Use the Authenticator toolkit component to manage your OAuth credentials and pass it to the ArcGISEnvironment.

Add the ArcGIS Maps SDK for Swift Toolkit package to your application by following these instructions.

In the Project Navigator, click MainApp.swift.

Add import ArcGISToolkit into the code.
Declare and initialize an Authenticator toolkit component in the MainApp struct.
Implement an initializer in the MainApp struct.
Create a new instance of the Authenticator using an OAuthUserConfiguration
Add your PortalURL, clientID and redirectURL values.
Pass the authenticator to the ArcGISEnvironment.authenticationManager to handle any challenges.

MainApp.swift
Use dark colors for code blocks

import SwiftUI

import ArcGIS

import ArcGISToolkit

@main
struct MainApp: App {

    @ObservedObject var authenticator: Authenticator

    init() {

        authenticator = Authenticator(oAuthUserConfigurations: [
            OAuthUserConfiguration(

                portalURL: URL(string: "<#YOUR-PORTAL-URL#>")!,
                clientID: "#<YOUR-CLIENT-ID>#",
                redirectURL: URL(string: "<#YOUR-REDIRECT-URL#>")!

            )
        ])
        ArcGISEnvironment.authenticationManager.handleChallenges(using: authenticator)

    }

In the body, add an .authenticator(authenticator) modifier to the ContentView.

MainApp.swift
Use dark colors for code blocks
    var body: some SwiftUI.Scene {

        WindowGroup {
            ContentView()

                .authenticator(authenticator)

        }
    }

Best Practice: The OAuth credentials are 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.

Add a map

Create a map that contains a topographic basemap layer. The map will be centered on the Santa Monica Mountains in California.

In the Project Navigator, click ContentView.swift.
In the Editor, add an import statement to reference the API.
ContentView.swift
Use dark colors for code blocks
15 15 15 15 15 15 15 15 15 15 15 15 15 15 15 16 17 18 19 19 19 19 19 19 19 19 19 19 19 19 19 19 19 19 19 19 19
Add line.
```
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
import SwiftUI

import ArcGIS
```
Add a @State property wrapper named map of type Map with a default value. Create a Map with an arcGISTopographic basemap style and return it.
ContentView.swift
Use dark colors for code blocks
19 19 19 19 19 19 19 19 19 19 19 19 19 19 19 19 19 19 19 20 21 22 23 24 24 24 25 26 27 27 27 27 27 27 27 27 28
Add line.Add line.Add line.Add line.Add line.
```
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
struct ContentView: View {

    @State private var map = {
        let map = Map(basemapStyle: .arcGISTopographic)

        return map
    }()

}
```
Attention
ArcGIS Enterprise users do not have access to the ArcGIS Location basemap styles service. If you are building an app for ArcGIS Enterprise users, you need to create a Map with a basemap that is accessible to them.

Set the map's initialViewpoint property with a Viewpoint using the Santa Monica Mountains coordinates.

ContentView.swift
Use dark colors for code blocks
21
21
21
21
21
21
21
21
21
21
21
21
21
21
21
21
21
21
21
21
21
22
23
24
25
26
27
28
28
27
26
25
24
23
22
21
21
Add line.    @State private var map = {
        let map = Map(basemapStyle: .arcGISTopographic)

        map.initialViewpoint = Viewpoint(latitude: 34.02700, longitude: -118.80500, scale: 72_000)

        return map
    }()

Add a map view

A map view is a UI component that displays a map. It also handles user interactions with the map, including navigating with touch gestures. Use Xcode and SwiftUI to add a map view.

In the body, create a MapView with the map created in the previous step.

ContentView.swift
Use dark colors for code blocks
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
30
31
32
33
34
35
35
35
Add line.Add line.    var body: some View {

        // Displays the map.
        MapView(map: map)

    }

MapView conforms to the Apple View protocol.

Run the solution

In the Project Navigator, click MainApp.swift.
In the body, add an .ignoresSafeArea() modifier to the ContentView. The ContentView's body contains the MapView and this modifier ensures that the map view is displayed beyond the safe area to all edges.
MainApp.swift
Use dark colors for code blocks
73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 73 74 74 74 74 74 74
Add line.
```
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
                .ignoresSafeArea()
```
Press Command + R to run the app.

If you are using the Xcode simulator your system must meet these minimum requirements: macOS 14 (Sonoma), Xcode 16, iOS 18. If you are using a physical device, then refer to the system requirements.

You should see a map with the topographic basemap layer centered on the Santa Monica Mountains in California. Pinch, drag, and double-tap the map view to explore the map.

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

Option 2: Download the solution

Click the Download solution link under Solution and unzip the file to a location on your machine.
Open the .xcodeproj file in Xcode.

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

In the Project Navigator, click MainApp.swift.

Set the AuthenticationMode to .apiKey.

MainApp.swift
Use dark colors for code blocks
    // Change the `AuthenticationMode` to `.apiKey` if your application uses API key authentication.

    private var authenticationMode: AuthenticationMode { .apiKey }

Set the apiKey property with your API key access token.

MainApp.swift
Expand
Use dark colors for code blocks
    // 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.

Use the Authenticator toolkit component to manage your OAuth credentials and pass it to the ArcGISEnvironment.

In the Project Navigator, click MainApp.swift.

Set the AuthenticationMode to .user.

MainApp.swift
Use dark colors for code blocks
// Change the `AuthenticationMode` to `.user` if your application uses OAuth credentials.

    private var authenticationMode: AuthenticationMode { .user }

Set your portalURL, clientID and redirectURL values.

MainApp.swift
Expand
Use dark colors for code blocks
    // Setup an `Authenticator` with OAuth configuration if your application uses OAuth credentials.
    @ObservedObject var authenticator = Authenticator(
        oAuthUserConfigurations: [
            OAuthUserConfiguration(

                // Please enter OAuth credentials for user authentication.

                portalURL: URL(string: "YOUR-PORTAL-URL")!,
                clientID: "YOUR-CLIENT-ID",
                redirectURL: URL(string: "YOUR-REDIRECT-URL")!

            )
        ]
    )
Expand

Best Practice: The OAuth credentials are 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

Press Command + R to run the app.

If you are using the Xcode simulator your system must meet these minimum requirements: macOS 14 (Sonoma), Xcode 16, iOS 18. If you are using a physical device, then refer to the system requirements.

You should see a map with the topographic basemap layer centered on the Santa Monica Mountains in California. Pinch, drag, and double-tap the map view to explore the map.

What's next?

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