Display a custom basemap style | MapLibre GL JS

Learn how to create a custom basemap styleA basemap style is a definition that controls the visual appearance of how geographic data in a basemap are displayed. It includes colors, backgrounds, outlines, labels, and other visual elements. Each basemap style emphasizes a specific type of cartographic theme and data.Learn more using ArcGIS Vector Tile Style Editor and display it in a mapA map is a collection of layers that are displayed in 2D. It is typically composed of a basemap layer and data layers.Learn more.

Display a custom basemap style using API key authentication

A basemap styleA basemap style is a definition that controls the visual appearance of how geographic data in a basemap are displayed. It includes colors, backgrounds, outlines, labels, and other visual elements. Each basemap style emphasizes a specific type of cartographic theme and data.Learn more provides the visual context for a mapA map is a collection of layers that are displayed in 2D. It is typically composed of a basemap layer and data layers.Learn more. You can use the default basemap styles provided by the ArcGIS Basemap servicesArcGIS Basemap services, also referred to as Basemap services, are location services hosted by Esri that provide data sources for building mapping applications. It includes the ArcGIS Basemap Styles service and ArcGIS Static Basemap Tiles service. Each service provides a specific type of basemap data and set of styles.Learn more or create a custom basemap style with the ArcGIS Vector Tile Style EditorThe ArcGIS Vector Tile Style Editor is a web-based application used to create, edit, and save a custom style for vector tile basemap layer.Learn more.

In this tutorial, use ArcGIS Vector Tile Style EditorThe ArcGIS Vector Tile Style Editor is a web-based application used to create, edit, and save a custom style for vector tile basemap layer.Learn more and the MapLibre ArcGIS plugin to create and display a custom basemap styleA basemap style is a definition that controls the visual appearance of how geographic data in a basemap are displayed. It includes colors, backgrounds, outlines, labels, and other visual elements. Each basemap style emphasizes a specific type of cartographic theme and data.Learn more in a mapA map is a collection of layers that are displayed in 2D. It is typically composed of a basemap layer and data layers.Learn more.

Prerequisites

You need an ArcGIS Location Platform or ArcGIS Online account.

Steps

Create a custom basemap style

You can create your own custom basemap with the ArcGIS Vector Tile Style EditorThe ArcGIS Vector Tile Style Editor is a web-based application used to create, edit, and save a custom style for vector tile basemap layer.Learn more.

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 and follow the steps to create a new app.

Choose API key authentication if you:

Want the easiest way to get started.
Want to build public applicationsA public application is an application that allows anonymous access without requiring users to sign in with an ArcGIS account. It supports API key or app authentication.Learn more that access ArcGIS Location ServicesArcGIS Location Services, also referred to as Location Services, are services hosted by Esri that provide geospatial functionality for developing mapping applications. They include the ArcGIS Basemap Styles service, ArcGIS Static Basemap Tiles service, ArcGIS Places service, ArcGIS Geocoding service, ArcGIS Routing service, ArcGIS GeoEnrichment service, and ArcGIS Elevation service. An ArcGIS Location Platform or ArcGIS Online account is required to use the services.Learn more and secure itemsAn item, also known as a content item, is a resource stored in a portal such as a web map, hosted layer, style, script tool, file, or notebook.Learn more.
Have an ArcGIS Location Platform or ArcGIS Online account.

Choose user authentication if you:

Want to build private applications.
Require application users to sign in with their own ArcGIS accountAn ArcGIS account is an identity with a user type and set of privileges that can access specific ArcGIS products, tools, APIs, services, and resources. The main account types that can be used for development are an ArcGIS Location Platform account, ArcGIS Online account, and ArcGIS Enterprise account. ArcGIS Location Platform and ArcGIS Online accounts are also associated with a subscription.Learn more and access resources their behalf.
Have an ArcGIS Online account.

To learn more about both types of authentication, go to Authentication.

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 a new API key credentialAPI key credentials are an item that contains the parameters used to create and manage long-lived access tokens for API key authentication. They are a type of developer credential.Learn more with the correct privileges to get an access token.

Go to the Create an API key tutorial to follow the steps to get an access token with these privilege(s)Privileges are a set of permissions assigned to ArcGIS accounts, developer credentials, and applications that grant access to secure resources and functionality in ArcGIS.Learn more:
- 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 credentialsAPI key credentials are an item that contains the parameters used to create and manage long-lived access tokens for API key authentication. They are a type of developer credential.Learn more access to the layer item. Learn more in Item access privileges.

Create a new OAuth credentialOAuth credentials are an item that contains parameters required to implement user authentication or app authentication, including a client_id, client_secret, and redirect URIs. They are a type of developer credential.Learn more to register the application.

Go to the Create OAuth credentials for user authentication tutorial to create an OAuth credential.
Copy the Client ID and Redirect URL from your OAuth credentials item and paste them to a safe location. They will be used in a later step.

Set developer credentials

Use the API key or OAuth developer credentialsDeveloper credentials are a type of item in a portal that contains parameters for authentication. There are two types of developer credentials: API key credentials and OAuth credentials.Learn more so your application can access ArcGIS servicesA service, also known as an ArcGIS service, is software that supports an ArcGIS REST API and provides geospatial functionality or data. A service can be hosted by Esri or in ArcGIS Enterprise.Learn more.

Update the accessToken variable to use your API key.

Expand
Use dark colors for code blocksCopy
    /* 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 credentialsOAuth credentials are an item that contains parameters required to implement user authentication or app authentication, including a client_id, client_secret, and redirect URIs. They are a type of developer credential.Learn more.

index.html
Use dark colors for code blocksCopy
    /* 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 blocksCopy
    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 style

Use the MapLibre ArcGIS plugin to access the custom basemap style by referencing its item IDAn item, also known as a content item, is a resource stored in a portal such as a web map, hosted layer, style, script tool, file, or notebook.Learn more. You can find its item ID by accessing it in your portalArcGIS portal, also known as a portal, is a website with applications and tools that can be used to create, manage, access, and share geospatial content and data. It supports security and authentication, developer credentials, content and data service management, user and group management, and site administration. A portal can be hosted in Esri's infrastructure or your own infrastructure.Learn more or the ArcGIS Vector Tile Style EditorThe ArcGIS Vector Tile Style Editor is a web-based application used to create, edit, and save a custom style for vector tile basemap layer.Learn more.

Go to the item pageAn item page is a web page in ArcGIS Online or the developer dashboard used to access and manage the properties for an item and the content it references such as a web map, hosted layer, or file.Learn more of the custom basemap style that you previously created and find its item IDAn item, also known as a content item, is a resource stored in a portal such as a web map, hosted layer, style, script tool, file, or notebook.Learn more. The ID is at the end of the URL, for example 9d94a890b76a417cad8a748df4f97336.

Reference the item ID in your BasemapStyle object.

Expand
Use dark colors for code blocksCopy
    const basemapStyle = maplibreArcGIS.BasemapStyle.applyStyle(map, {
      style: "9d94a890b76a417cad8a748df4f97336",
      token: accessToken
    });
Expand

Security and authentication guide

If you would like to use your own vector tile layer or basemap layer style in your app, you can use an access tokenAn access token is an authorization string that provides access to secure ArcGIS content, data, and services. Its capabilities are determined by the privileges it supports. It is obtained by implementing API key authentication, User authentication, or App authentication.Learn more from API key authenticationAPI key authentication is a type of authentication that uses an API key to authenticate requests to ArcGIS services and secure portal items.Learn more or app authenticationApp authentication is a type of authentication that grants a short-lived access token based on an OAuth 2.0 client ID and client secret, authorizing an application to access ArcGIS services and items.Learn more to authenticate the request. Learn more in Types of authentication .

Run the app

Run the app.

The map should display the custom basemap style created using ArcGIS Vector Tile Style Editor.

What's next?

Learn how to use additional location services in these tutorials:

Map of the United States with a dropdown menu for selecting basemap style.

Change the basemap style

Switch a vector basemap style on a map.

Map of Europe with country and city names rendered in Japanese script.

Change language labels

Switch the language of place labels on a basemap.

A vector tile layer showing detailed streets and labels for Malibu, California.

Add a vector tile layer

Add a vector tile layer to a map.