Display a map

Learn how to use the ArcGIS Static Basemap Tiles service to display a raster tile basemap.

Display a map using API key authentication

The ArcGIS Static Basemap Tiles service provides basemap data as pre-rendered and pre-styled map tiles for the world. The service provides styles from the ArcGIS Basemap styles family that are grouped into categories such as streets, topography, satellite, reference, and creative.

In this tutorial, you display the ArcGIS Navigation basemap style provided by the service.

Prerequisites

You need an ArcGIS Location Platform account.

ArcGIS Online and ArcGIS Enterprise accounts are not supported.

Steps

Create a new app

Select a type of authentication below and follow the steps to create a new application.

Create a new CodePen app with a map div that is the full width and height of the browser window.

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

In CodePen > HTML, add HTML and CSS to create a page with a div element called map.

Use the HTML to create a page with a map. Use the map div to display the map. Use the CSS to make the map full width and height.

The <!DOCTYPE html> tag is not required in CodePen. If you are using a different editor or running the page on a local server, be sure to add this tag to the top of your HTML page.

Use dark colors for code blocks
<!DOCTYPE html>
<html>

<head>

  <meta charset="utf-8" />
  <meta name="viewport" content="initial-scale=1, maximum-scale=1, user-scalable=no" />
  <title>MapLibre GL JS Tutorials: Display a map</title>
  <style>
    html,
    body,
    #map {
      padding: 0;
      margin: 0;
      height: 100%;
      width: 100%;
      font-family: Arial, Helvetica, sans-serif;
      font-size: 14px;
      color: #323232;
    }

  </style>

  <!-- Load MapLibre GL JS from CDN -->
  <script src=https://unpkg.com/maplibre-gl@5.9.0/dist/maplibre-gl.js></script>
  <link href=https://unpkg.com/maplibre-gl@5.9.0/dist/maplibre-gl.css rel="stylesheet" />

</head>

<body>
  <div id="map"></div>

</body>

</html>

Create a new app by downloading the user authentication starter app and add a map div that is the full width and height of the browser window.

Download the user authentication starter app.
Unzip the folder and open it in a text editor of your choice, such as Visual Studio Code. The starter app includes the following:
- callback.html: This contains callback as part of the authentication process.
- index.html: This contains app logic and the OAuth 2.0 code necessary to perform the authentication.

In the index.html, add a div element called map.

Use dark colors for code blocks
<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="initial-scale=1, maximum-scale=1, user-scalable=no" />
    <title>MapLibre GL JS Tutorials: Display a map (with user authentication)</title>
    <style>

      html,
      body,

      #map {
        padding: 0;
        margin: 0;
        height: 100%;
        width: 100%;
        font-family: Arial, Helvetica, sans-serif;
        font-size: 14px;
        color: #323232;
      }

    </style>
    <!-- ArcGIS REST JS used for user authentication. -->
    <script src="https://unpkg.com/@esri/arcgis-rest-request@4/dist/bundled/request.umd.js"></script>
    <!-- Load MapLibre GL JS from CDN -->
    <script src=https://unpkg.com/maplibre-gl@5.9.0/dist/maplibre-gl.js></script>
    <link href=https://unpkg.com/maplibre-gl@5.9.0/dist/maplibre-gl.css rel="stylesheet" />
  </head>
  <body>

    <div id="map"></div>

    <script type="module">

    </script>
  </body>
</html>

Apply CSS styling to the map div.

Expand
Use dark colors for code blocks
      html,
      body,

      #map {
        padding: 0;
        margin: 0;
        height: 100%;
        width: 100%;
        font-family: Arial, Helvetica, sans-serif;
        font-size: 14px;
        color: #323232;
      }

    </style>
    <!-- ArcGIS REST JS used for user authentication. -->
    <script src="https://unpkg.com/@esri/arcgis-rest-request@4/dist/bundled/request.umd.js"></script>
    <!-- Load MapLibre GL JS from CDN -->
    <script src=https://unpkg.com/maplibre-gl@5.9.0/dist/maplibre-gl.js></script>
    <link href=https://unpkg.com/maplibre-gl@5.9.0/dist/maplibre-gl.css rel="stylesheet" />
  </head>
  <body>

    <div id="map"></div>

    <script type="module">

Expand

Set up authentication

Create API key or user token 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 to follow the steps to get an access token with these privilege(s):
- Privileges
  - Location services > Basemaps > Static basemap tiles

Set developer credentials

Use the API key or OAuth developer credentials created in the previous step in your application.

Add a <script> element in the HTML <body> and create an accessToken variable to store your access token. Set YOUR_ACCESS_TOKEN with the access token you previously copied from your API key credentials.

Expand
Use dark colors for code blocks
  <script>

    /* Use for API key authentication */
    const accessToken = "YOUR_ACCESS_TOKEN";


  </script>
Expand

In both the index.html and callback.html files, set the properties of clientId and redirectUri 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
<!DOCTYPE html>
  <head>
    <title>MapLibre GL JS Tutorials: Display a map (with user authentication)</title>
    <script src="https://unpkg.com/@esri/arcgis-rest-request@4/dist/bundled/request.umd.js"></script>
  </head>
  <body>
    <script>

    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
    });

    </script>
  </body>
</html>

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!

Create a map

Create a basemapEnum and baseUrl to reference the style URL for arcgis/navigation.

Expand
Use dark colors for code blocks
  <script>

    /* 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: "https://www.arcgis.com/sharing/rest" // Your portal URL
    // })

    // const accessToken = session.token;

    const basemapEnum = "arcgis/navigation";
    const baseUrl = `https://static-map-tiles-api.arcgis.com/arcgis/rest/services/static-basemap-tiles-service/v1`;

  </script>
Expand

Create a Map that is centered on the world.

Expand
Use dark colors for code blocks
  <script>

    /* 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: "https://www.arcgis.com/sharing/rest" // Your portal URL
    // })

    // const accessToken = session.token;

    const basemapEnum = "arcgis/navigation";
    const baseUrl = `https://static-map-tiles-api.arcgis.com/arcgis/rest/services/static-basemap-tiles-service/v1`;

    const map = new maplibregl.Map({
      container: 'map',
      style: {
        'version': 8,
        'sources': {
          'raster-tiles': {
            'type': 'raster',
            'tiles': [
              `${baseUrl}/${basemapEnum}/static/tile/{z}/{y}/{x}?token=${accessToken}`
            ],
            'tileSize': 512,
          },
        },
        'layers': [
          {
            'id': 'simple-tiles',
            'type': 'raster',
            'source': 'raster-tiles',
            'minzoom': 0,
            'maxzoom': 22
          },
        ]
      },
      zoom: 2,
      center: [-20,30]
    });

    fetch(`${baseUrl}/${basemapEnum}/static?token=${accessToken}`) //Display required Esri and data attribution
      .then(response => response.json())
      .then(data => {
        map._controls[0]._innerContainer.innerText += " | Powered by Esri | " + data.copyrightText
    });

  </script>
Expand

Create a fetch request to retrieve and display the required Esri and data attribution on the map.

Expand
Use dark colors for code blocks
    const map = new maplibregl.Map({
      container: 'map',
      style: {
        'version': 8,
        'sources': {
          'raster-tiles': {
            'type': 'raster',
            'tiles': [
              `${baseUrl}/${basemapEnum}/static/tile/{z}/{y}/{x}?token=${accessToken}`
            ],
            'tileSize': 512,
          },
        },
        'layers': [
          {
            'id': 'simple-tiles',
            'type': 'raster',
            'source': 'raster-tiles',
            'minzoom': 0,
            'maxzoom': 22
          },
        ]
      },
      zoom: 2,
      center: [-20,30]
    });

    fetch(`${baseUrl}/${basemapEnum}/static?token=${accessToken}`) //Display required Esri and data attribution
      .then(response => response.json())
      .then(data => {
        map._controls[0]._innerContainer.innerText += " | Powered by Esri | " + data.copyrightText
    });
Expand

Run the app

Run the app.

The map should display the arcgis/navigation style from the Static Basemap Styles service.

What's next?

Learn how to use additional location services in these tutorials:

Change the static basemap tiles style

Switch a static basemap style on a map.

Change language labels for static basemap tiles

Switch the language labels on static basemap tiles.

Display multiple basemap layers

Add multiple basemap layers from different services to your map.