Display a custom basemap style | ArcGIS Maps SDK for JavaScript

Learn how to access and display a styled vector basemap layer in a map.

A styled basemap layer is a set of styles that you define to override one of the default basemap styles service vector tile layer styles. These are used to create and display a map or scene with your own custom styles, labels, and colors. To create a styled basemap layer, you can use the ArcGIS Vector Tile Style Editor . The editor stores your styles in ArcGIS as a layer item with an item ID .

In this tutorial, you will use an item ID to access and display a styled vector tile layer (Forest and Parks Canvas) in a map . You also add an image tile layer (World Hillshade) to enhance the visualization. Both layers are hosted in ArcGIS Online .

Prerequisites

Steps

Create a new pen

To get started, either complete the Display a map tutorial or .

Get an access token

You need an access token with the correct privileges to access the location services 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
In CodePen, set the apiKey property on the global esriConfig variable to your access token.
var esriConfig = { apiKey: "YOUR_ACCESS_TOKEN", };

To learn about other ways to get an access token, go to Types of authentication.

Add modules

In a new <script> at the bottom of the <body>, add the Basemap, VectorTileLayer, and TileLayer modules.

The ArcGIS Maps SDK for JavaScript is available via CDN and npm, but this tutorial is based on CDN. The $arcgis.import global function accepts a module path or array of module paths, and returns a promise that resolves with the requested modules. This function can only be used when working with the CDN; otherwise, use the standard import syntax. To learn more about the SDK’s different modules, visit the References page.

33 collapsed lines
<html>

<head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
  <title>ArcGIS Maps SDK for JavaScript Tutorials: Display a custom basemap style</title>

  <style>
    html,
    body {
      height: 100%;
      margin: 0;
    }
  </style>

  <script>
    var esriConfig = { apiKey: "YOUR_ACCESS_TOKEN" };
  </script>

  <!-- Load the ArcGIS Maps SDK for JavaScript from CDN -->
  <script type="module" src="https://js.arcgis.com/5.0/"></script>

</head>


<body>

  <arcgis-map basemap="arcgis/topographic" center="-118.805, 34.020" zoom="13">

    <arcgis-zoom slot="top-left"></arcgis-zoom>

  </arcgis-map>

  <script type="module">

    const [Basemap, TileLayer, VectorTileLayer] = await $arcgis.import([
      "@arcgis/core/Basemap.js",
      "@arcgis/core/layers/TileLayer.js",
      "@arcgis/core/layers/VectorTileLayer.js",
    ]);

  </script>
5 collapsed lines

</body>


</html>

Create a vector tile layer

You can access a basemap layer by referencing its item ID . You can find a layer’s item ID by accessing it with ArcGIS Online or the ArcGIS Vector Tile Style Editor .

Go to the Forest and Parks Canvas vector tile layer in ArcGIS Online and find its item ID . The ID is at the end of the URL.
In CodePen, create a new VectorTileLayer object and set its portalItem id property to d2ff12395aeb45998c1b154e25d680e5 and the opacity property to 0.75.

Learn more about loading a layer by its item ID in the API reference.
41 collapsed lines <html> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" /> <title>ArcGIS Maps SDK for JavaScript Tutorials: Display a custom basemap style</title> <style> html, body { height: 100%; margin: 0; } </style> <script> var esriConfig = { apiKey: "YOUR_ACCESS_TOKEN" }; </script>  <script type="module" src="https://js.arcgis.com/5.0/"></script> </head> <body> <arcgis-map basemap="arcgis/topographic" center="-118.805, 34.020" zoom="13"> <arcgis-zoom slot="top-left"></arcgis-zoom> </arcgis-map> <script type="module"> const [Basemap, TileLayer, VectorTileLayer] = await $arcgis.import([ "@arcgis/core/Basemap.js", "@arcgis/core/layers/TileLayer.js", "@arcgis/core/layers/VectorTileLayer.js", ]); const vectorTileLayer = new VectorTileLayer({ portalItem: { id: "6976148c11bd497d8624206f9ee03e30", // Forest and Parks Canvas }, opacity: 0.75, }); 6 collapsed lines </script> </body> </html>

Create an image tile layer

Use ArcGIS Online to find the item ID for the World Hillshade image tile layer and then use it to access the layer . The image tile layer will be used to visually enhance the styles with terrain.

Go to the World Hillshade image tile layer in ArcGIS and find its item ID. The ID is at the end of the URL.
In CodePen, create a new TileLayer and set its portalItem id property to 1b243539f4514b6ba35e7d995890db1d.

Learn more about loading a layer by its item ID in the API reference.

41 collapsed lines
<html>

<head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
  <title>ArcGIS Maps SDK for JavaScript Tutorials: Display a custom basemap style</title>

  <style>
    html,
    body {
      height: 100%;
      margin: 0;
    }
  </style>

  <script>
    var esriConfig = { apiKey: "YOUR_ACCESS_TOKEN" };
  </script>

  <!-- Load the ArcGIS Maps SDK for JavaScript from CDN -->
  <script type="module" src="https://js.arcgis.com/5.0/"></script>

</head>


<body>

  <arcgis-map basemap="arcgis/topographic" center="-118.805, 34.020" zoom="13">

    <arcgis-zoom slot="top-left"></arcgis-zoom>

  </arcgis-map>

  <script type="module">

    const [Basemap, TileLayer, VectorTileLayer] = await $arcgis.import([
      "@arcgis/core/Basemap.js",
      "@arcgis/core/layers/TileLayer.js",
      "@arcgis/core/layers/VectorTileLayer.js",
    ]);

    const vectorTileLayer = new VectorTileLayer({
      portalItem: {
        id: "6976148c11bd497d8624206f9ee03e30", // Forest and Parks Canvas
      },
      opacity: 0.75,
    });

    const hillshadeTileLayer = new TileLayer({
      portalItem: {
        id: "1b243539f4514b6ba35e7d995890db1d", // World Hillshade
      },
    });

6 collapsed lines
  </script>

</body>


</html>

Add the basemap layers

Basemaps can contain multiple baseLayers. Use the Basemap class to add the vectorTileLayerand hillshadeTileLayer created above. These layers will create the underlying style for the map. The vector tile layer provides the base colors and the image tile layer provides the hillshade or topographic effect.

In the main function, create a Basemap object and add vectorTileLayer and the hillshadeTileLayer to the baseLayers array.

41 collapsed lines
<html>

<head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
  <title>ArcGIS Maps SDK for JavaScript Tutorials: Display a custom basemap style</title>

  <style>
    html,
    body {
      height: 100%;
      margin: 0;
    }
  </style>

  <script>
    var esriConfig = { apiKey: "YOUR_ACCESS_TOKEN" };
  </script>

  <!-- Load the ArcGIS Maps SDK for JavaScript from CDN -->
  <script type="module" src="https://js.arcgis.com/5.0/"></script>

</head>


<body>

  <arcgis-map basemap="arcgis/topographic" center="-118.805, 34.020" zoom="13">

    <arcgis-zoom slot="top-left"></arcgis-zoom>

  </arcgis-map>

  <script type="module">

    const [Basemap, TileLayer, VectorTileLayer] = await $arcgis.import([
      "@arcgis/core/Basemap.js",
      "@arcgis/core/layers/TileLayer.js",
      "@arcgis/core/layers/VectorTileLayer.js",
    ]);

    const vectorTileLayer = new VectorTileLayer({
      portalItem: {
        id: "6976148c11bd497d8624206f9ee03e30", // Forest and Parks Canvas
      },
      opacity: 0.75,
    });

    const hillshadeTileLayer = new TileLayer({
      portalItem: {
        id: "1b243539f4514b6ba35e7d995890db1d", // World Hillshade
      },
    });

    const basemap = new Basemap({ baseLayers: [hillshadeTileLayer, vectorTileLayer] });

6 collapsed lines
  </script>

</body>


</html>

Update the map’s basemap property to use the basemap object created earlier.

41 collapsed lines
<html>

<head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
  <title>ArcGIS Maps SDK for JavaScript Tutorials: Display a custom basemap style</title>

  <style>
    html,
    body {
      height: 100%;
      margin: 0;
    }
  </style>

  <script>
    var esriConfig = { apiKey: "YOUR_ACCESS_TOKEN" };
  </script>

  <!-- Load the ArcGIS Maps SDK for JavaScript from CDN -->
  <script type="module" src="https://js.arcgis.com/5.0/"></script>

</head>


<body>

  <arcgis-map basemap="arcgis/topographic" center="-118.805, 34.020" zoom="13">

    <arcgis-zoom slot="top-left"></arcgis-zoom>

  </arcgis-map>

  <script type="module">

    const [Basemap, TileLayer, VectorTileLayer] = await $arcgis.import([
      "@arcgis/core/Basemap.js",
      "@arcgis/core/layers/TileLayer.js",
      "@arcgis/core/layers/VectorTileLayer.js",
    ]);

    const vectorTileLayer = new VectorTileLayer({
      portalItem: {
        id: "6976148c11bd497d8624206f9ee03e30", // Forest and Parks Canvas
      },
      opacity: 0.75,
    });

    const hillshadeTileLayer = new TileLayer({
      portalItem: {
        id: "1b243539f4514b6ba35e7d995890db1d", // World Hillshade
      },
    });

    const basemap = new Basemap({ baseLayers: [hillshadeTileLayer, vectorTileLayer] });

    const viewElement = document.querySelector("arcgis-map");
    viewElement.basemap = basemap;

6 collapsed lines
  </script>

</body>


</html>

Update the map position

Update the center and zoom properties to zoom the display to North America.

56 collapsed lines
<html>

<head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
  <title>ArcGIS Maps SDK for JavaScript Tutorials: Display a custom basemap style</title>

  <style>
    html,
    body {
      height: 100%;
      margin: 0;
    }
  </style>

  <script>
    var esriConfig = { apiKey: "YOUR_ACCESS_TOKEN" };
  </script>

  <!-- Load the ArcGIS Maps SDK for JavaScript from CDN -->
  <script type="module" src="https://js.arcgis.com/5.0/"></script>

</head>


<body>

  <arcgis-map basemap="arcgis/topographic" center="-118.805, 34.020" zoom="13">

    <arcgis-zoom slot="top-left"></arcgis-zoom>

  </arcgis-map>

  <script type="module">

    const [Basemap, TileLayer, VectorTileLayer] = await $arcgis.import([
      "@arcgis/core/Basemap.js",
      "@arcgis/core/layers/TileLayer.js",
      "@arcgis/core/layers/VectorTileLayer.js",
    ]);

    const vectorTileLayer = new VectorTileLayer({
      portalItem: {
        id: "6976148c11bd497d8624206f9ee03e30", // Forest and Parks Canvas
      },
      opacity: 0.75,
    });

    const hillshadeTileLayer = new TileLayer({
      portalItem: {
        id: "1b243539f4514b6ba35e7d995890db1d", // World Hillshade
      },
    });

    const basemap = new Basemap({ baseLayers: [hillshadeTileLayer, vectorTileLayer] });

    const viewElement = document.querySelector("arcgis-map");
    viewElement.basemap = basemap;

    viewElement.center = [-100, 40];
    viewElement.zoom = 3;
7 collapsed lines

  </script>

</body>


</html>

Run the app

In CodePen, run your code to display the map.

The map should display the Forest and Parks Canvas vector tile layer on top of the World Hillshade image tile layer. The styled vector tile layer is displayed on top of the hillshade terrain.

What’s next?

Learn how to use additional SDK features and ArcGIS services in these tutorials: