Change the basemap style

Learn how to change a basemap style in a map.

Change the basemap style using API key authentication

The ArcGIS Basemap Styles service provides a number of basemap styles such as topography, streets, outdoor, navigation, and imagery that you can use in maps. To access these basemap styles in your MapLibre GL JS app, use the MapLibre ArcGIS plugin.

In this tutorial, use a <select> dropdown menu to toggle between different basemap styles.

Prerequisites

You need 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 to follow the steps to get an access token with these privilege(s):
- Privileges
  - Location services > Basemaps

Set developer credentials

Use the API key or OAuth developer credentials so your application can access ArcGIS 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!

Add a style selector

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

Expand
Use dark colors for code blocks
  </style>
  <!-- Load MapLibre GL JS from CDN -->
  <script src=https://unpkg.com/maplibre-gl@5.8.0/dist/maplibre-gl.js></script>
  <link href=https://unpkg.com/maplibre-gl@5.8.0/dist/maplibre-gl.css rel="stylesheet" />
  <!-- Load MapLibre ArcGIS from CDN -->
  <script src="https://unpkg.com/@esri/maplibre-arcgis@1.0.0/dist/umd/maplibre-arcgis.min.js"></script>

</head>

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

  <div id="basemaps-wrapper">

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

  </div>
Expand

In the <style> element, add CSS styling to the basemaps-wrapper and basemaps.

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;
      background: rgba(255, 255, 255, 0);
    }

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


  </style>
  <!-- Load MapLibre GL JS from CDN -->
  <script src=https://unpkg.com/maplibre-gl@5.8.0/dist/maplibre-gl.js></script>
  <link href=https://unpkg.com/maplibre-gl@5.8.0/dist/maplibre-gl.css rel="stylesheet" />
  <!-- Load MapLibre ArcGIS from CDN -->
  <script src="https://unpkg.com/@esri/maplibre-arcgis@1.0.0/dist/umd/maplibre-arcgis.min.js"></script>
Expand

Set the basemap

Using the MapLibre ArcGIS plugin, reference the Basemap Styles service and a style enumeration to update the map. This will be used when a selection is made.

Comment out the map style as it will be updated dynamically based on the user's selection.

Expand
Use dark colors for code blocks
    // const basemapStyle = maplibreArcGIS.BasemapStyle.applyStyle(map, {
    //   style: 'arcgis/outdoor',
    //   token: accessToken
    // });
Expand

Define a function to update the map style using the selected basemap layer.

Expand
Use dark colors for code blocks
    const setBasemap = (selection) => {
      const basemapStyle = maplibreArcGIS.BasemapStyle.applyStyle(map, {
        style: selection,
        token: accessToken
      });
    };
Expand

Select the DOM element used for the basemap selector.

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

Use the MapLibre ArcGIS plugin to make a request to the Basemap Styles service. This dynamically fetches the available basemap styles and populates the select element.

Expand
Use dark colors for code blocks
    maplibreArcGIS.BasemapStyle.getSelf().then(response => {
      const basemapStyles = response.styles.filter(style => !style.deprecated)
      basemapStyles.forEach(style => {
        const option = document.createElement("option");
        option.value = style.path;
        option.textContent = style.name;
        basemapsSelectElement.appendChild(option);
      });

    })
Expand

Initialize the basemap layer with the first style returned from the response. This ensures the map loads with a default style when the page first loads.

Expand
Use dark colors for code blocks
    maplibreArcGIS.BasemapStyle.getSelf().then(response => {
      const basemapStyles = response.styles.filter(style => !style.deprecated)
      basemapStyles.forEach(style => {
        const option = document.createElement("option");
        option.value = style.path;
        option.textContent = style.name;
        basemapsSelectElement.appendChild(option);
      });

      setBasemap(response.styles[0].path);

    })
Expand

Run the code to ensure that the <select> element contains different basemap enumerations.

Add an event listener

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

Add an event listener to update the map to the new basemap when the selector is changed.

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

    maplibreArcGIS.BasemapStyle.getSelf().then(response => {
      const basemapStyles = response.styles.filter(style => !style.deprecated)
      basemapStyles.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