Change the basemap style (v2)

Learn how to change a basemap style in a map using the basemap styles service v2.

The basemap styles service provides a number basemap layer styles such as topography, streets, and imagery that you can use in maps. The basemap styles service v2 comes with additional styles including: ArcGIS Outdoor, OSM Navigation, and OSM Blueprint.

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

Prerequisites

You need an ArcGIS Developer or ArcGIS Online account to access the developer dashboard and create an API key.

Steps

Create a new pen

Go to CodePen to create a new pen for your application.

Set the API key

To access location services, you need an API key or OAuth 2.0 access token. To learn how to create and scope your key, visit the Create an API key tutorial.

Go to your dashboard to get an API key. The API key must be scoped to access the services used in this tutorial.

In CodePen, update apiKey to use your key.

Use dark colors for code blocks
const apiKey = "YOUR_API_KEY";
const basemapEnum = "arcgis/streets";
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=${apiKey}`,
  zoom: 12, // starting zoom
  center: [-118.805, 34.027] // starting location [longitude, latitude]
});

Add a 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@3.2.1/dist/maplibre-gl.js></script>
    <link href=https://unpkg.com/maplibre-gl@3.2.1/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@3.2.1/dist/maplibre-gl.js></script>
    <link href=https://unpkg.com/maplibre-gl@3.2.1/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 apiKey = "YOUR_API_KEY";

      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=${apiKey}`,
        zoom: 12, // starting zoom
        center: [-118.805, 34.027], // starting location [longitude, latitude]
        attributionControl: false
      }).addControl(
        new maplibregl.AttributionControl({
          compact: true // reduces the copyright attributions view
        })
      );

      const baseUrl = "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles";
      const url = (style) => `${baseUrl}/${style}?token=${apiKey}`;
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=${apiKey}`;

      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);
        console.log(e.target.value);
      });
Expand