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 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 session = await arcgisRest.ArcGISIdentityManager.beginOAuth2({
      clientId: "YOUR_CLIENT_ID", // Your client ID from OAuth credentials
      redirectUri: "YOUR_REDIRECT_URL", // The redirect URL registered in your OAuth credentials
      portal: "https://www.arcgis.com/sharing/rest" // Your portal URL
    })

callback.html
Use dark colors for code blocks
    arcgisRest.ArcGISIdentityManager.completeOAuth2({
      clientId: "YOUR_CLIENT_ID", // Your client ID from OAuth credentials
      redirectUri: "YOUR_REDIRECT_URL", // 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

Create a <div> tag to contain the <select> dropdown menu. Add basemap layer enumerations from the v2 basemap styles service as <option>s.

Expand
Use dark colors for code blocks
  </style>
  <script src=https://unpkg.com/maplibre-gl@4/dist/maplibre-gl.js></script>
  <link href=https://unpkg.com/maplibre-gl@4/dist/maplibre-gl.css rel="stylesheet" />

</head>


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

  <div id="basemaps-wrapper">

    <select id="basemaps">
      <option value="arcgis/outdoor">arcgis/outdoor</option>
      <option value="arcgis/community">arcgis/community</option>
      <option value="arcgis/navigation">arcgis/navigation</option>
      <option value="arcgis/streets">arcgis/streets</option>
      <option value="arcgis/streets-relief">arcgis/streets-relief</option>
      <option value="arcgis/imagery">arcgis/imagery</option>
      <option value="arcgis/oceans">arcgis/oceans</option>
      <option value="arcgis/topographic">arcgis/topographic</option>
      <option value="arcgis/light-gray">arcgis/light-gray</option>
      <option value="arcgis/dark-gray">arcgis/dark-gray</option>
      <option value="arcgis/human-geography">arcgis/human-geography</option>
      <option value="arcgis/charted-territory">arcgis/charted-territory</option>
      <option value="arcgis/nova">arcgis/nova</option>
      <option value="osm/standard">osm/standard</option>
      <option value="osm/navigation">osm/navigation</option>
      <option value="osm/streets">osm/streets</option>
      <option value="osm/blueprint">osm/blueprint</option>
    </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>
  <script src=https://unpkg.com/maplibre-gl@4/dist/maplibre-gl.js></script>
  <link href=https://unpkg.com/maplibre-gl@4/dist/maplibre-gl.css rel="stylesheet" />
Expand

Set the basemap

Use a function to reference the basemap styles service and a style enumeration to update the map. This will be used when a selection is made.

Create a baseUrl and a url element. The url element will append the name of the basemap selected from the dropdown menu.

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_URL", // The redirect URL registered in your OAuth credentials
    //   portal: "https://www.arcgis.com/sharing/rest" // Your portal URL
    // })

    // const accessToken = session.token;

    const basemapEnum = "arcgis/outdoor";
    const map = new maplibregl.Map({
      container: "map", // the id of the div element
      style: `https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/${basemapEnum}?token=${accessToken}`,
      zoom: 12, // starting zoom
      center: [-118.805, 34.027] // starting location [longitude, latitude]
    })

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

Set the style of the map with the new basemap layer.

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) => {
      // Instantiate the given basemap layer.
      map.setStyle(url(style));
    };
Expand

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

Add an event listener

Use an event listener to register a basemap change in the <select> element and to update the map.

Set the default basemap to arcgis/outdoor.

Expand
Use dark colors for code blocks
    const setBasemap = (style) => {
      // Instantiate the given basemap layer.
      map.setStyle(url(style));
    };

    setBasemap("arcgis/outdoor");
Expand

Create a basemapsSelectElement to return the basemap from the selector.

Expand
Use dark colors for code blocks
    setBasemap("arcgis/outdoor");

    const basemapsSelectElement = document.querySelector("#basemaps");
Expand

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");

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

Run the app

Run the app.

Try selecting different basemap styles from the selector. As you select the different styles, you should see the basemap change accordingly.

What's next?

Learn how to use additional ArcGIS location services in these tutorials:

Change the basemap style

Switch a basemap style in a map using the basemap styles service.

Change language labels for basemap styles

Switch the language of place labels on a basemap.

Display a custom basemap style

Add a styled vector basemap layer to a map.

Display basemap places

Display places of interest on a basemap and request additional information about them.

Change the static basemap tiles style

Change the basemap style in a map using the static basemap tiles service (beta).