Change the basemap style

Learn how to change a basemap styleA basemap layer is the layer in a map or scene that displays basemap data. The data source for a basemap layer is typically a basemap service.Learn more in a mapA map is a collection of layers that are displayed in 2D. It is typically composed of a basemap layer and data layers.Learn more.

Change the basemap style using API key authentication

The ArcGIS Basemap Styles serviceThe ArcGIS Basemap Styles service, also referred to as the Basemap Styles service, is a location service that provides basemap styles and data for the world. It returns styles as Mapbox styles and web maps, and data as vector tiles and/or map tiles. It supports all of the styles in the ArcGIS Basemap style and Open Basemap style family. An ArcGIS Location Platform or ArcGIS Online account is required to use the service.Learn more 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 and follow the steps to create a new app.

Choose API key authentication if you:

Want the easiest way to get started.
Want to build public applicationsA public application is an application that allows anonymous access without requiring users to sign in with an ArcGIS account. It supports API key or app authentication.Learn more that access ArcGIS Location ServicesArcGIS Location Services, also referred to as Location Services, are services hosted by Esri that provide geospatial functionality for developing mapping applications. They include the ArcGIS Basemap Styles service, ArcGIS Static Basemap Tiles service, ArcGIS Places service, ArcGIS Geocoding service, ArcGIS Routing service, ArcGIS GeoEnrichment service, and ArcGIS Elevation service. An ArcGIS Location Platform or ArcGIS Online account is required to use the services.Learn more and secure itemsAn item, also known as a content item, is a resource stored in a portal such as a web map, hosted layer, style, script tool, file, or notebook.Learn more.
Have an ArcGIS Location Platform or ArcGIS Online account.

Choose user authentication if you:

Want to build private applications.
Require application users to sign in with their own ArcGIS accountAn ArcGIS account is an identity with a user type and set of privileges that can access specific ArcGIS products, tools, APIs, services, and resources. The main account types that can be used for development are an ArcGIS Location Platform account, ArcGIS Online account, and ArcGIS Enterprise account. ArcGIS Location Platform and ArcGIS Online accounts are also associated with a subscription.Learn more and access resources their behalf.
Have an ArcGIS Online account.

To learn more about both types of authentication, go to Authentication.

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 a new API key credentialAPI key credentials are an item that contains the parameters used to create and manage long-lived access tokens for API key authentication. They are a type of developer credential.Learn more with the correct privileges to get an access token.

Go to the Create an API key tutorial to follow the steps to get an access token with these privilege(s)Privileges are a set of permissions assigned to ArcGIS accounts, developer credentials, and applications that grant access to secure resources and functionality in ArcGIS.Learn more:
- Privileges
  - Location services > Basemaps

Create a new OAuth credentialOAuth credentials are an item that contains parameters required to implement user authentication or app authentication, including a client_id, client_secret, and redirect URIs. They are a type of developer credential.Learn more to register the application.

Go to the Create OAuth credentials for user authentication tutorial to create an OAuth credential.
Copy the Client ID and Redirect URL from your OAuth credentials item and paste them to a safe location. They will be used in a later step.

Set developer credentials

Use the API key or OAuth developer credentialsDeveloper credentials are a type of item in a portal that contains parameters for authentication. There are two types of developer credentials: API key credentials and OAuth credentials.Learn more so your application can access ArcGIS servicesA service, also known as an ArcGIS service, is software that supports an ArcGIS REST API and provides geospatial functionality or data. A service can be hosted by Esri or in ArcGIS Enterprise.Learn more.

Update the accessToken variable to use your API key.

Expand
Use dark colors for code blocksCopy
    /* 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 credentialsOAuth credentials are an item that contains parameters required to implement user authentication or app authentication, including a client_id, client_secret, and redirect URIs. They are a type of developer credential.Learn more.

index.html
Use dark colors for code blocksCopy
    /* 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 blocksCopy
    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.23.0/dist/maplibre-gl.js"></script>
    <link href="https://unpkg.com/maplibre-gl@5.23.0/dist/maplibre-gl.css" rel="stylesheet">
    <!-- Load MapLibre ArcGIS from CDN -->
    <script src="https://unpkg.com/@esri/maplibre-arcgis@1.1.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.23.0/dist/maplibre-gl.js"></script>
    <link href="https://unpkg.com/maplibre-gl@5.23.0/dist/maplibre-gl.css" rel="stylesheet">
    <!-- Load MapLibre ArcGIS from CDN -->
    <script src="https://unpkg.com/@esri/maplibre-arcgis@1.1.0/dist/umd/maplibre-arcgis.min.js"></script>
Expand

Set the basemap

Using the MapLibre ArcGIS plugin, reference the Basemap Styles serviceThe ArcGIS Basemap Styles service, also referred to as the Basemap Styles service, is a location service that provides basemap styles and data for the world. It returns styles as Mapbox styles and web maps, and data as vector tiles and/or map tiles. It supports all of the styles in the ArcGIS Basemap style and Open Basemap style family. An ArcGIS Location Platform or ArcGIS Online account is required to use the service.Learn more and a style enumeration to update the mapA map is a collection of layers that are displayed in 2D. It is typically composed of a basemap layer and data layers.Learn more. 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 blocksCopy
    // 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