Display a custom basemap style

Learn how to add a custom vector basemap layer to a map.

Display a custom basemap style using API key authentication

A basemap layer provides the visual context for a map. You can use the default basemap layer styles provided by basemap services or you can create your own custom styles with the ArcGIS Vector Tile Style Editor for specific mapping applications.

In this tutorial, you use ArcGIS Vector Tile Style Editor and MapLibre GL JS to create and display a styled vector basemap layer in a map.

Prerequisites

An ArcGIS Location Platform or ArcGIS Online account.

Steps

Create a custom basemap

You can create your own custom basemap with the ArcGIS Vector Tile Style Editor.

Go to the Vector Tile Style Editor.
Sign in with your ArcGIS account.
Click + New style.
In the Select a style to continue panel, click Popular > Light Gray Canvas.
In left-panel, click Quick Edit. Style the basemap using Colors, Font, Label Size, and Road Width. For example:
- Colors
  - Land: #cbe8b0
  - Water: #b9dbf7
  - Roads: #f0f1f0
  - Boundaries: #ffffff
  - Buildings: #ebe7dc
  - Nature: #f0fae6
In the search tool of the map, enter Yosemite National Park.
Click on any green area to open the Admin0 forest or park layer.
In the map, zoom out to level 6 so that the layer disappears.
In the Layer Editor > Visibility panel, set the first number of the Visible Zoom Range to 3 to make the layer visible.
In the Layer Editor > Appearance panel, set the fill and outline color properties to change at different zoom levels using either hex codes or the color selector. For example:
- Color > Settings icon > Set Value by Zoom level:
  - 3 #ddf0ca
  - 6 #cbe5b1
  - Click Add Stop and enter: 10 #bae291.
- Outline Color: #bbd4a2
- Opacity: 60%
In the toolbar, click Save As to save your customized basemap. Enter a Title and Tags.

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
- Item access
  - Note: If you are using your own custom data layer for this tutorial, you need to grant the API key credentials access to the layer item. Learn more in Item access privileges.
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 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 blocks
    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!

Display the custom basemap

You can access a basemap layer by referencing its item ID. You can find a layer's item ID by accessing it in your portal or the ArcGIS Vector Tile Style Editor.

Go to the item page of the custom basemap style that you previously created and find its item ID. The ID is at the end of the URL, for example 9d94a890b76a417cad8a748df4f97336

Change the basemapId from arcgis/outdoor to your own item ID and the style endpoint to enable your custom item.

Expand
Use dark colors for code blocks
    /* Use for API key authentication */
    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_URI", // The redirect URL registered in your OAuth credentials
    //   portal: "YOUR_PORTAL_URL" // Your portal URL
    // })

    // const accessToken = session.token;

    const basemapEnum = "9d94a890b76a417cad8a748df4f97336"; // Custom vector tile style

    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/items/${basemapEnum}?token=${accessToken}`,

      zoom: 10, // starting zoom
      center: [-118.805, 34.027] // starting location [longitude, latitude]
    });
Expand