Display a map

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

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

Choose your API

You can do this tutorial in C++ or QML. Make your selection below:

• Steps for C++
• Steps for QML

Steps for C++

Create a new ArcGIS Maps Qt Creator Project

Use Qt Creator to create an app that displays a Map centered on the Santa Monica Mountains.

1. Start Qt Creator.

2. Click File > New File or Project. Under Projects, select ArcGIS.

3. Select the ArcGIS Maps 200.2.0 Qt Quick C++ app project template (or a later version) and click Choose.

   More info

   You may have several selections for the ArcGIS project type. Be sure to select ArcGIS Maps 200.2.0 Qt Quick C++ app (or a later version).

4. In the Project Location dialog, name your project display_a_map. Click Next.

5. In the Define Build System dialog, select qmake for your build system. Click Next.

6. In the Define Project Details dialog, give this app a description or leave as is. Leave the rest of this dialog as is.

7. Leave the 3D project box unchecked. At the ArcGIS Online Basemap dropdown menu, select Topographic. Then click Next.

8. On the Kit Selection dialog, check the kit(s) you previously set up when you installed the API. You should select a Desktop kit to run this tutorial. Then click Next.

9. At the Project Management dialog, the option to Add as a subproject to root project is only available if you have already created a root project. Ignore this dialog for this tutorial. Click Next.

Set your API key

An API key is required to enable access to services, web maps, and web scenes hosted in ArcGIS Online.

If you haven't already, 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.

1. In the Projects window, in the Sources folder, open the main.cpp file. Modify the code to set the API key. Paste the API key, acquired from your dashboard, between the quotes. Then save and close the file.

   main.cpp

   Expand

   Use dark colors for code blocks

   39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 40 41 42 43 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44 44

   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
   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
   80
       // 2. API key authentication: Get a permanent key that gives your application access to Esri
       // location services. Create a new API key or access existing API keys from
       // your ArcGIS for Developers dashboard (https://links.esri.com/arcgis-api-keys).
   
       const QString apiKey = QString("");
   

   Expand

Add a map

Use the map view to display a map centered on the Santa Monica Mountains in California. The map will contain a layer built from the ArcGISTopographic BasemapStyle.

1. In the Projects window, open the Headers folder. Double-click the file display_a_map.h to open it.

1. Add the declaration void setupViewpoint(); under private:. Then save and close the file.

   Display_a_map.h

   Expand

   Use dark colors for code blocks

   39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 39 40 41 42 43 44 44 44 44 44 44 44 44 44

   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
   private:
       Esri::ArcGISRuntime::MapQuickView* mapView() const;
       void setMapView(Esri::ArcGISRuntime::MapQuickView* mapView);
   
       void setupViewpoint();
   

   Expand

2. In the Projects window, open the Sources folder. Open the display_a_map.cpp file.

3. Add the following #include statements.

   Display_a_map.cpp

   Expand

   Use dark colors for code blocks

   12 12 12 12 12 12 12 12 12 12 12 12 13 14 15 16 17 18 19 20 21 21 21 21 21 21 21 21 20 19 19 19 19 19 19 19 19 19 19 19 19 19 18 17 16 15 14 13 12 11 10 10 10 10 10 10 10 10 10 10 10 10 10 10 9 8 8 8

   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
   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
   #include "Display_a_map.h"
   #include "Map.h"
   #include "MapTypes.h"
   #include "MapQuickView.h"
   
   #include "Point.h"
   #include "Viewpoint.h"
   #include "SpatialReference.h"
   #include "TaskWatcher.h"
   

   Expand

Create the view point

1. Add code to implement the setupViewpoint method. This method creates a center Point based on a SpatialReference along with longitude and latitude. It also creates a Viewpoint based on center and sets scale. Lastly, it asynchronously sets the initial Map viewpoint.

   More info

   The center Point and scale value keep the initial Viewpoint centered and focused on the Santa Monica Mountains. The scale value sets the level of detail to focus on the area of interest.

   The spatial reference created above is set to use World Geodetic System 1984 (WGS84), the spatial reference commonly used for GPS, and it has the well known id 4326. To learn more, see Spatial References in the ArcGIS Maps SDK for Qt Guide.

   Display_a_map.cpp

   Expand

   Use dark colors for code blocks

   37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 51 51 51 51 51 51 51 51 51 51 51 51 51 50 49 49 49

   Add line.Add line.Add line.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
   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
   MapQuickView* Display_a_map::mapView() const
   {
       return m_mapView;
   }
   
   void Display_a_map::setupViewpoint()
   {
   
       const Point center(-118.80543, 34.02700, SpatialReference::wgs84());
       const Viewpoint viewpoint(center, 100000.0);
       m_mapView->setViewpoint(viewpoint);
   
   }
   
   

   Expand
   More info

   The setMapView method appearing later in this file gets a handle to the MapView object that was declared in QML code and sets the Map on the MapView for display. This code is installed by the templates that ArcGIS provides when creating a new project in Qt. You should not modify it.

2. Add the following line of code to call setupViewpoint.

   Display_a_map.cpp

   Expand

   Use dark colors for code blocks

   52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 52 53 54 55 56 57 58 59 60 61 62 63 64 65 65 65 65

   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
   // Set the view (created in QML)
   void Display_a_map::setMapView(MapQuickView* mapView)
   {
       if (!mapView || mapView == m_mapView)
       {
           return;
       }
   
       m_mapView = mapView;
   
       m_mapView->setMap(m_map);
   
       setupViewpoint();
   

   Expand

3. Press <Ctrl+R> to run the app.

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

To explore other tutorials, see What's next.

Steps for QML

Create a new ArcGIS Maps Qt Creator Project

Use Qt Creator to create an app that displays a Map centered on the Santa Monica Mountains.

1. Start Qt Creator.

2. Click File > New File or Project. In the left-most window, under Projects, select ArcGIS.

3. Select the ArcGIS Maps 200.2.0 Qt Quick QML app project template (or a later version) and click Choose.

   More info

   You may have several selections available for the ArcGIS project type. Be sure to select ArcGIS Maps 200.2.0 Qt Quick QML app (or a later version).

4. In the Project Location dialog, name your project Display_a_map.

5. At the Create in field, browse to where you want to place this project. Click Next.

6. In the Define Build System dialog, select qmake for your build system. Click Next.

7. In the Define Project Details dialog, give this app a description or leave as is.

8. At the ArcGIS Online Basemap drop-down menu, select Topographic. Click Next.

9. On the Kit Selection dialog, check the kit(s) you previously set up when you installed the API. Select a Desktop kit to run this tutorial. Click Next.

   More info

   The option to Add as a subproject to root project is only available if you have already created a root project. Ignore for this tutorial.

10. Verify your selections and click Finish.

Set your API key

An API key is required to enable access to services, web maps, and web scenes hosted in ArcGIS Online.

If you haven't already, 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.

1. In the Projects window, in the Sources folder, open the main.cpp file.

2. Modify the code to set the API key. Paste the API key, acquired from your dashboard, between the quotes. Then save and close the file.

   main.cpp

   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 68 69 70 71 72 73 74 75 76 77 78 79 80

   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
   80
   // Copyright 2022 ESRI
   //
   // All rights reserved under the copyright laws of the United States
   // and applicable international laws, treaties, and conventions.
   //
   // You may freely redistribute and use this sample code, with or
   // without modification, provided you include the original copyright
   // notice and use restrictions.
   //
   // See the Sample code usage restrictions document for further information.
   //
   
   #include <QGuiApplication>
   #include <QQmlApplicationEngine>
   #include <QQuickWindow>
   #include <QDir>
   
   //------------------------------------------------------------------------------
   
   int main(int argc, char *argv[])
   {
       qDebug() << "Initializing application";
   
       QGuiApplication app(argc, argv);
   
       // Use of Esri location services, including basemaps and geocoding, requires
       // an access token. For more information see
       // https://links.esri.com/arcgis-runtime-security-auth.
   
       // The following methods grant an access token:
   
       // 1. User authentication: Grants a temporary access token associated with a user's ArcGIS account.
       // To generate a token, a user logs in to the app with an ArcGIS account that is part of an
       // organization in ArcGIS Online or ArcGIS Enterprise.
   
       // 2. API key authentication: Get a permanent key that gives your application access to Esri
       // location services. Create a new API key or access existing API keys from
       // your ArcGIS for Developers dashboard (https://links.esri.com/arcgis-api-keys).
   
       const QString apiKey = QString("");
   
       if (apiKey.isEmpty())
       {
           qWarning() << "Use of Esri location services, including basemaps, requires" <<
                         "you to implement user authentication or set the API Key property.";
       }
       else
       {
           QCoreApplication::instance()->setProperty("Esri.ArcGISRuntime.apiKey", apiKey);
       }
   
       // Production deployment of applications built with ArcGIS Runtime requires you to
       // license ArcGIS Runtime functionality. For more information see
       // https://links.esri.com/arcgis-runtime-license-and-deploy.
   
       // QCoreApplication::instance()->setProperty("Esri.ArcGISRuntime.license", "licenseString");
   
       // Intialize application window
       QQmlApplicationEngine appEngine;
       appEngine.addImportPath(QDir(QCoreApplication::applicationDirPath()).filePath("qml"));
   
   #ifdef ARCGIS_RUNTIME_IMPORT_PATH_2
       appEngine.addImportPath(ARCGIS_RUNTIME_IMPORT_PATH_2);
   #endif
   
       appEngine.load(QUrl("qrc:/qml/main.qml"));
   
       auto topLevelObject = appEngine.rootObjects().value(0);
       auto window = qobject_cast<QQuickWindow*>(topLevelObject);
       if (!window)
       {
           qCritical("Error: Your root item has to be a Window.");
   
           return -1;
       }
   
       window->show();
   
       return app.exec();
   }

Update the map

This application will use the map view to display a map centered on the Santa Monica Mountains in California. The map will contain a layer built from the ArcGISTopographic BasemapStyle.

1. If the main.qml file is not already open, in the Projects window, navigate to Resources > qml\qml.qrc > /qml and open the main.qml file.

2. Within the Map object, set the property initialViewpoint toviewpoint (you will create this object in the next step).

   main.qml

   Expand

   Use dark colors for code blocks

   28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 29 30 31 32 33 34 35 35 35 35 33 31 29 27 25 23 21 19 17 15 14 13 12 11 11 11

   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
           // add a map to the mapview
           Map {
   
               // add the ArcGISTopographic basemap to the map
               initBasemapStyle: Enums.BasemapStyleArcGISTopographic
   
               initialViewpoint: viewpoint
   

   Expand

Define the viewpoint

"A ViewpointCenter defines a map area using a location (point) and a map scale. You can create a new ViewpointCenter to define the initial viewpoint to display when the map loads."

1. After the closing brace of Map, create an instance of ViewpointCenter with an id of viewpoint. You will initially see an Expected token }' error, however you will add the closing brace when you are done defining the ViewpointCenter.

   main.qml

   Expand

   Use dark colors for code blocks

   28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 28 29 30 31 32 33 34 35 36 37 38 39 40 40 38 36 34 32 30 28 26 25 24 23 22 22 22

   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
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
           // add a map to the mapview
           Map {
   
               // add the ArcGISTopographic basemap to the map
               initBasemapStyle: Enums.BasemapStyleArcGISTopographic
   
               initialViewpoint: viewpoint
   
           }
   
           ViewpointCenter {
               id: viewpoint
   

   Expand

2. Set the ViewpointCenter center property to a Point, with x (longitude), y (latitude), and SpatialReference properties set as shown. Be sure to add the closing brace for Point.

   More info

   The center property set to Point and targetScale value keep map's initial viewpoint centered and focused on the Santa Monica Mountains. The scale value sets the level of detail to focus on the area of interest.

   The spatial reference created above is set to use World Geodetic System 1984 (WGS84), the spatial reference commonly used for GPS, and it has the well known id 4326. To learn more, see Spatial References in the ArcGIS Maps SDK for Qt Guide.

   main.qml

   Expand

   Use dark colors for code blocks

   38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 38 39 40 41 42 43 44 45 46 47 47 46 45 44 43 43 43

   Add line.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
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
           ViewpointCenter {
               id: viewpoint
   
               // Specify the center Point
               center: Point {
                   x: -118.80543
                   y: 34.02700
                   spatialReference: SpatialReference {wkid: 4326}
               }
   

   Expand

3. Set the targetScale property of viewpoint as shown. Add the following code, including the closing brace. This will remove the Expected token }' error.

   main.qml

   Expand

   Use dark colors for code blocks

   41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 42 43 44 45 46 47 48 49 50 51 51 51 51

   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
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
               // Specify the center Point
               center: Point {
                   x: -118.80543
                   y: 34.02700
                   spatialReference: SpatialReference {wkid: 4326}
               }
   
               // Specify the scale
               targetScale: 100000.0
           }
   

   Expand

4. Press <Ctrl+R> to run the app.

You should see a map with the topographic basemap layer centered on the Santa Monica Mountains in California. Zoom in and out, and drag 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:

• Add a point, line, and polygon
• Add a feature layer
• Search for an address
• Find a route and directions
• Display a web map
• Display a scene