Change the basemap style

Learn how to change a basemap style in a map.

Change the basemap style using API key authentication

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

In this tutorial, you use a <select> dropdown menu with ol-mapbox-style to toggle between a number of different basemap layer styles.

Prerequisites

An ArcGIS Location Platform or ArcGIS Online 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 the correct 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
Copy the API key access token to your clipboard when prompted.

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.

Expand
Use dark colors for code blocks
    /* Use for API key authentication */
    const accessToken = "YOUR_ACCESS_TOKEN";
Expand

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!

Remove basemap references

Remove the basemapId, basemapURL, and the olms function.

Expand
Use dark colors for code blocks
  <script>

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

    // or

    /* Use for user authentication */
    // const session = await arcgisRest.ArcGISIdentityManager.beginOAuth2({
    //   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
    // })

    // const accessToken = session.token;

    const map = new ol.Map({ target: "map" });

    map.setView(
      new ol.View({
        center: ol.proj.fromLonLat([-118.805, 34.027]),
        zoom: 12
      })
    );

    const basemapId = "arcgis/outdoor";

    const basemapURL = `https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/${basemapId}?token=${accessToken}`;

    olms.apply(map, basemapURL)

      .then(() => {
        // Add Esri attribution
        // Learn more in https://esriurl.com/attribution
        const source = map.getLayers().item(0).getSource();
        source.setAttributions("Powered by <a href='https://www.esri.com/en-us/home' target='_blank'>Esri</a> | ")

      });

  </script>
Expand

Add a basemap selector

OpenLayers does not have a basemap layer switching widget, so you will use the a plain HTML <select> element.

In the <head> tag, add CSS that will position the <select> menu wrapper element in the upper right corner and provide styling.

Expand
Use dark colors for code blocks
  <style>
    html,
    body,
    #map {
      padding: 0;
      margin: 0;
      height: 100%;
      width: 100%;
      font-family: Arial, Helvetica, sans-serif;
      font-size: 14px;
      color: #323232;
    }


    #basemaps-wrapper {
      position: absolute;
      top: 20px;
      right: 20px;
    }

    #basemaps {
      font-size: 16px;
      padding: 4px 8px;
    }


  </style>
Expand

In the <body> element, add the wrapper tag with an id of basemaps-wrapper.

Expand
Use dark colors for code blocks

<body>
  <div id="map"></div>

  <div id="basemaps-wrapper">

  </div>
Expand

In the wrapper element, add a <select> element, which you will populate in a later step.

Expand
Use dark colors for code blocks
  <div id="basemaps-wrapper">

    <select id="basemaps"></select>

  </div>
Expand

Set the initial basemap layer

When the page loads, initialize the basemap layer to the first option in the menu.

Create a function called url that computes the style service URL for a basemap layer.

Expand
Use dark colors for code blocks
  <script>

    const accessToken = "YOUR_ACCESS_TOKEN";

    // or

    /* Use for user authentication */
    // const session = await arcgisRest.ArcGISIdentityManager.beginOAuth2({
    //   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
    // })

    // const accessToken = session.token;

    const map = new ol.Map({ target: "map" });
    map.setView(
      new ol.View({
        center: ol.proj.fromLonLat([-118.805, 34.027]),
        zoom: 12
      })
    );

    const baseUrl = "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles";
    const url = (style) => `${baseUrl}/${style}?token=${accessToken}`;
Expand

Create a function called setBasemap that will clear existing layers and use olms to instantiate a basemap layer by name.

Expand
Use dark colors for code blocks
    const baseUrl = "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles";
    const url = (style) => `${baseUrl}/${style}?token=${accessToken}`;

    const setBasemap = (style) => {
      // Clear out existing layers.
      map.setLayerGroup(new ol.layer.Group());

      // Instantiate the given basemap layer.
      olms.apply(map, url(style)).then(() => {

        // Add Esri attribution
        // Learn more in https://esriurl.com/attribution
        const source = map.getLayers().item(0).getSource();
        source.setAttributions("Powered by <a href='https://www.esri.com/en-us/home' target='_blank'>Esri</a> | ")

      });
    };
Expand

Extract the <select> DOM element using document.querySelector to populate it.

Expand
Use dark colors for code blocks
    const basemapsSelectElement = document.querySelector("#basemaps");
Expand

Import arcgisRest.request() to make a request to the basemap styles service. This dynamically fetches the available basemap styles and populates the select element.

Use dark colors for code blocks
  <!-- REST JS -->
  <script src="https://unpkg.com/@esri/arcgis-rest-request@4/dist/bundled/request.umd.js"></script>

Expand
Use dark colors for code blocks
    arcgisRest.request(`${baseUrl}/self`, {
      httpMethod: "GET"
    }).then(response => {
      response.styles.forEach(style => {
        const option = document.createElement("option");
        option.value = style.path
        option.textContent = style.name
        basemapsSelectElement.appendChild(option)
      })

    })
Expand

Call setBasemap to initialize the basemap layer to the first basemap in the select element.

Expand
Use dark colors for code blocks
    arcgisRest.request(`${baseUrl}/self`, {
      httpMethod: "GET"
    }).then(response => {
      response.styles.forEach(style => {
        const option = document.createElement("option");
        option.value = style.path
        option.textContent = style.name
        basemapsSelectElement.appendChild(option)
      })

      setBasemap(response.styles[0].path)

    })
Expand

Set the selected basemap layer

Call setBasemap when the user selects an option in the <select> menu.

Call setBasemap in response to change events on the <select> element.

Expand
Use dark colors for code blocks
    const basemapsSelectElement = document.querySelector("#basemaps");

    arcgisRest.request(`${baseUrl}/self`, {
      httpMethod: "GET"
    }).then(response => {
      response.styles.forEach(style => {
        const option = document.createElement("option");
        option.value = style.path
        option.textContent = style.name
        basemapsSelectElement.appendChild(option)
      })

      setBasemap(response.styles[0].path)

    })

    basemapsSelectElement.addEventListener("change", (e) => {
      setBasemap(e.target.value);
    });
Expand