Display multiple basemap layers

Learn how to add multiple basemap layers from different services to your map.

Display multiple basemap layers with API key authentication

This tutorial shows how to display two basemap layers from different services in your application. You will use the World Imagery map tile service satellite imagery basemap to provide the underlying visual and geographic context for the map. To provide additional context, you will use the arcgis/imagery/labels style from the static basemap tiles service to display place labels for the world. The combination of the two layers will result in a basemap that provides additional context for the mapping application.

Prerequisites

An ArcGIS Location Platform account.

Steps

Get the starter app

Select a type of authentication below and follow the steps to create a new application.

You can choose one of the following to create a new CodePen:

Option 1: Complete the Display a map tutorial; or,
Option 2: Start from the Display a map tutorial .

Set up authentication

Create developer credentials in your portal for the type of authentication you selected.

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

Go to the Create an API key tutorial and create an API key with the following privilege(s):
- Privileges
  - Location services > Basemaps > Static basemap tiles
When prompted, copy and paste the API key to a safe location. It will be used in the next step.

Set developer credentials

Use the API key or OAuth developer credentials so your application can access location services.

Update the accessToken variable to use your API key.

Use dark colors for code blocks
  <script>

    /* Use for API key authentication */
    const accessToken = "YOUR_ACCESS_TOKEN";

    const map = L.map("map", {
      minZoom: 2
    })

    map.setView([34.02, -118.805], 13);

    const basemapEnum = "arcgis/streets";

    L.esri.Vector.vectorBasemapLayer(basemapEnum, {
      token: accessToken
    }).addTo(map);

  </script>

In both the index.html and callback.html files, replace YOUR_CLIENT_ID and YOUR_REDIRECT_URL with the client ID and redirect URL of your OAuth credentials.

index.html
Use dark colors for code blocks
    /* Use for user authentication */
    const clientId = "YOUR_CLIENT_ID"; // Your client ID from OAuth credentials
    const redirectUri = "YOUR_REDIRECT_URI"; // The redirect URL registered in your OAuth credentials
    const session = await arcgisRest.ArcGISIdentityManager.beginOAuth2({
      clientId,
      redirectUri,
      portal: "https://www.arcgis.com/sharing/rest" // Your portal URL
    })

    const accessToken = session.token;

callback.html
Use dark colors for code blocks
    arcgisRest.ArcGISIdentityManager.completeOAuth2({
      clientId: "YOUR_CLIENT_ID", // Your client ID from OAuth credentials
      redirectUri: "YOUR_REDIRECT_URI", // The redirect URL registered in your OAuth credentials
      portal: "https://www.arcgis.com/sharing/rest" // Your portal URL
    })

Run the app and ensure you can sign in successfully.

If you are unable to sign in, make sure you have the correct redirect URL and port. This URL varies based on your application and typically takes the format of https://<server>[:port]/callback.html or http://my-arcgis-app:/auth. For example, if you are running an application on http://127.0.0.1:5500/, set http://127.0.0.1:5500/callback.html as your redirect URL in the index.html and callback.html file and your developer credential. They all have to match!

Update script references

The map will use static basemap tiles as its basemap layer. Therefore, you remove references to the esri-leaflet-vector plugin and the vector basemap layer. Then, you reference the staticBasemapTileLayer plugin.

Remove the script references to esri-leaflet-vector plugin.

Use dark colors for code blocks

<head>
  <meta charset="utf-8" />
  <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no" />
  <title>Esri Leaflet Tutorials: Display a map</title>

  <!-- Load Leaflet from CDN -->
  <link rel="stylesheet" href="https://unpkg.com/leaflet@1.9.4/dist/leaflet.css" crossorigin="" />
  <script src="https://unpkg.com/leaflet@1.9.4/dist/leaflet.js" crossorigin=""></script>

  <!-- Load Esri Leaflet from CDN -->
  <script src="https://unpkg.com/esri-leaflet@3.0.16/dist/esri-leaflet.js"></script>

  <script src="https://unpkg.com/esri-leaflet-vector@4.2.8/dist/esri-leaflet-vector.js"></script>

Remove the basemapEnum and vectorBasemapLayer references.

Use dark colors for code blocks
    const map = L.map("map", {
      minZoom: 2
    })

    map.setView([34.02, -118.805], 13);

    const basemapEnum = "arcgis/streets";

    L.esri.Vector.vectorBasemapLayer(basemapEnum, {
      token: accessToken
    }).addTo(map);

Add <script> tag to reference the staticBasemapTileLayer plugin.

Use dark colors for code blocks
    <!-- Load Leaflet from CDN -->
    <link rel="stylesheet" href="https://unpkg.com/leaflet@1.9.4/dist/leaflet.css" crossorigin="" />
    <script src="https://unpkg.com/leaflet@1.9.4/dist/leaflet.js" crossorigin=""></script>
    <!-- Load Esri Leaflet from CDN -->
    <script src="https://unpkg.com/esri-leaflet@3.0.16/dist/esri-leaflet.js"></script>

    <script src="https://unpkg.com/esri-leaflet-static-basemap-tile@1/dist/esri-leaflet-static-basemap-tile.js"></script>

Update the map's viewpoint

Change the map's center to [37.1174, -91.2996] and zoom level to 5. This will focus the map on the United States of America.

Expand
Use dark colors for code blocks
      const map = L.map("map", {
        minZoom: 2

      }).setView([37.1174, -91.2996], 5);
Expand

Add basemap layer 1

Use the TiledMapLayer class to access and display basemap layer from the World Imagery map tile service.

Access the map tile layer with TiledMapLayer. Then, add it to your map.

Expand
Use dark colors for code blocks
      const tileLayer = L.esri.tiledMapLayer({
        url: "https://ibasemaps-api.arcgis.com/arcgis/rest/services/World_Imagery/MapServer",
        token: accessToken
      });

      tileLayer.addTo(map);
Expand

Add basemap layer 2

In this step, you add another basemap layer from the static basemap tiles service to provide place labels.

Add the arcgis/imagery/labels basemap style from the static basemap tiles service to display labels on top of the map tile layer.

Expand
Use dark colors for code blocks
      const basemapEnum = "arcgis/imagery/labels";
      L.esri.Static.staticBasemapTileLayer(basemapEnum, {
        token: accessToken
      }).addTo(map);
Expand