Change the basemap layer

Learn how to change the basemap layer in a map.

The basemap layer service provides a number of basemap layer styles such as topography, streets, and imagery that you can use in maps.

In this tutorial, you will use the Basemap Toggle and BasemapGallery widgets to select and display different basemap layers.

Prerequisites

Steps

Create a new pen

1. To get started, either complete the Display a map tutorial or use this pen.

Set the API key

To access ArcGIS services, you need an API key.

1. Go to your dashboard to get an API key.

2. In CodePen, set the apiKey to your key, so it can be used to access basemap layer and location services.

   Use dark colors for code blocks

       

   Change line

   1
   2
   3
   4
   esriConfig.apiKey = "YOUR_API_KEY";
   const map = new Map({
     basemap: "arcgis-topographic" // Basemap layer service
   });

Add modules

1. In the require statement, add the Basemap Toggle and BasemapGallery modules.

   More info

   The ArcGIS Maps SDK for JavaScript is available as AMD modules and ES modules, but this tutorial is based on AMD. The AMD require function uses references to determine which modules will be loaded – for example, you can specify "esri/Map" for loading the Map module. After the modules are loaded, they are passed as parameters (e.g. Map) to the callback function where they can be used in your application. It is important to keep the module references and callback parameters in the same order. For more information on the different types of modules, visit the Introduction to Tooling guide topic.

   Expand

   Use dark colors for code blocks

                                                                      

   Add line.Add line.Change 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
       require([
         "esri/config",
         "esri/Map",
         "esri/views/MapView",
   
         "esri/widgets/BasemapToggle",
         "esri/widgets/BasemapGallery"
   
       ], function(esriConfig, Map, MapView, BasemapToggle, BasemapGallery) {
   

   Expand

Toggle between basemaps

An easy way to enable selection between two basemaps is to use the Basemap Toggle widget. Use the widget to toggle between arcgis-topographic and arcgis-imagery basemaps.

1. Create a Basemap Toggle and set the view. Set the nextBasemap property to arcgis-imagery.

   Expand

   Use dark colors for code blocks

                                                                      

   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
         const view = new MapView({
           container: "viewDiv",
           map: map,
           center: [-118.80543,34.02700],
           zoom: 13
         });
   
         const basemapToggle = new BasemapToggle({
           view: view,
           nextBasemap: "arcgis-imagery"
        });
   
   

   Expand

2. Add the widget to the bottom-right corner of of the view.

   Expand

   Use dark colors for code blocks

                                                                      

   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
         const view = new MapView({
           container: "viewDiv",
           map: map,
           center: [-118.80543,34.02700],
           zoom: 13
         });
   
         const basemapToggle = new BasemapToggle({
           view: view,
           nextBasemap: "arcgis-imagery"
        });
   
         view.ui.add(basemapToggle,"bottom-right");
   

   Expand

3. Switch between basemaps.

Select basemaps from a gallery

You can also use the BasemapGallery widget to select different basemaps.

1. Create a BasemapGallery and set the query in the source property to search for the "World Basemaps for Developers" basemap group.

   More info

   In a future release, you will not need to set the source when using API keys.

   Expand

   Use dark colors for code blocks

                                                                      

   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
         view.ui.add(basemapToggle,"bottom-right");
   
         const basemapGallery = new BasemapGallery({
           view: view,
           source: {
             query: {
               title: '"World Basemaps for Developers" AND owner:esri'
             }
           }
         });
   
   

   Expand

2. Add the widget to the top-right corner of the view.

   Expand

   Use dark colors for code blocks

                                                                      

   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
         view.ui.add(basemapToggle,"bottom-right");
   
         const basemapGallery = new BasemapGallery({
           view: view,
           source: {
             query: {
               title: '"World Basemaps for Developers" AND owner:esri'
             }
           }
         });
   
         view.ui.add(basemapGallery, "top-right"); // Add to the view
   

   Expand

Run the App

In CodePen, run your code to display the map.

You should have two widgets in your application that provide different ways to choose basemaps.

What's Next?

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

• Add a vector tile layer
• Add a feature layer
• Display a custom basemap style