Change the basemap layer

Learn how to change a basemap layer from the basemap layer service using MapLibre GL JS.

The basemap layer service provides a number of basemap layer styles such as topography, streets, 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

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

Steps

Create a new pen

  1. 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.

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

  2. In CodePen, update apiKey to use your key.

    Use dark colors for code blocks
              
    Change line
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    const apiKey = "YOUR_API_KEY";
    const basemapEnum = "ArcGIS:Streets";
    const map = new maplibregl.Map({
      container: "map", // the id of the div element
      style: `https://basemaps-api.arcgis.com/arcgis/rest/services/styles/${basemapEnum}?type=style&token=${apiKey}`,
      zoom: 12, // starting zoom
      center: [-118.805, 34.027] // starting location [longitude, latitude]
    });
    

Add a selector

  1. Create a <div> tag to contain the <select> dropdown menu. Add a basemap layer enumeration for each <options></options> element.

    Expand
    Use dark colors for code blocks
                                                                                                   
    Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
        </style>
        <script src=https://unpkg.com/maplibre-gl@2.1.9/dist/maplibre-gl.js></script>
        <link href=https://unpkg.com/maplibre-gl@2.1.9/dist/maplibre-gl.css rel="stylesheet" />
    
      </head>
    
      <body>
        <div id="map"></div>
    
        <div id="basemaps-wrapper">
    
          <select id="basemaps">
            <option value="ArcGIS:Streets">Streets</option>
            <option value="ArcGIS:Navigation">Navigation</option>
            <option value="ArcGIS:Topographic">Topographic</option>
            <option value="ArcGIS:LightGray">Light Gray</option>
            <option value="ArcGIS:DarkGray">Dark gray</option>
            <option value="ArcGIS:StreetsRelief">Streets Relief</option>
            <option value="ArcGIS:Imagery:Standard">Imagery</option>
            <option value="ArcGIS:ChartedTerritory">ChartedTerritory</option>
            <option value="ArcGIS:ColoredPencil">ColoredPencil</option>
            <option value="ArcGIS:Nova">Nova</option>
            <option value="ArcGIS:Midcentury">Midcentury</option>
            <option value="OSM:Standard">OSM</option>
            <option value="OSM:Streets">OSM:Streets</option>
          </select>
    
        </div>
    
    Expand
  2. In the <style> element, add CSS styling to the basemaps-wrapper and basemaps.

    Expand
    Use dark colors for code blocks
                                                                                                   
    Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
        <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@2.1.9/dist/maplibre-gl.js></script>
        <link href=https://unpkg.com/maplibre-gl@2.1.9/dist/maplibre-gl.css rel="stylesheet" />
    
    Expand

Set the basemap

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

  1. 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
                                                                                                   
    Add line.Add line.
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
        <script>
          const apiKey = "YOUR_API_KEY";
          const basemapEnum = "ArcGIS:Streets";
          const map = new maplibregl.Map({
            container: "map", // the id of the div element
            style: `https://basemaps-api.arcgis.com/arcgis/rest/services/styles/${basemapEnum}?type=style&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://basemaps-api.arcgis.com/arcgis/rest/services/styles";
          const url = (name) => `${baseUrl}/${name}?type=style&token=${apiKey}`;
    
    Expand
  2. Set the style of the map with the new basemap layer.

    Expand
    Use dark colors for code blocks
                                                                                                   
    Add line.Add line.Add line.Add line.
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
          const baseUrl = "https://basemaps-api.arcgis.com/arcgis/rest/services/styles";
          const url = (name) => `${baseUrl}/${name}?type=style&token=${apiKey}`;
    
          const setBasemap = (name) => {
            // Instantiate the given basemap layer.
            map.setStyle(url(name));
          };
    
    Expand
  3. 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.

  1. Set the default basemap to ArcGIS:Streets.

    Expand
    Use dark colors for code blocks
                                                                                                   
    Add line.
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
          const setBasemap = (name) => {
            // Instantiate the given basemap layer.
            map.setStyle(url(name));
          };
    
          setBasemap("ArcGIS:Streets");
    
    Expand
  2. Create a basemapsSelectElement to return the basemap from the selector.

    Expand
    Use dark colors for code blocks
                                                                                                   
    Add line.
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
          setBasemap("ArcGIS:Streets");
    
          const basemapsSelectElement = document.querySelector("#basemaps");
    
    Expand
  3. Add an event listener to update the map to the new basemap when the selector is changed.

    Expand
    Use dark colors for code blocks
                                                                                                   
    Add line.Add line.Add line.
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
          const basemapsSelectElement = document.querySelector("#basemaps");
    
          basemapsSelectElement.addEventListener("change", (e) => {
            setBasemap(e.target.value);
          });
    
    Expand

Run the app

In CodePen, run your code to display the map.

You should be able to use the select element to switch between basemap layers.

What's next?

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

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.