Display a map

Learn how to display a map with a basemap layer using MapLibre GL JS.

You can display a map in MapLibre GL JS by using a vector tile basemap layer from the basemap styles service. A vector tile basemap layer is a MapLibre GL style containing a source, layers, font glyphs, and icons to render the layers.

In this tutorial, you display a map of the Santa Monica Mountains using the streets basemap layer from the Basemap styles service.

This tutorial is the starting point for the other MapLibre tutorials.

Prerequisites

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

Steps

Create a new pen

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

Add HTML

Define an HTML page to create a map that is the full width and height of the browser window.

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

The HTML will create a page with a map that is the full width and height. The map div is the element used to display the map. The CSS resets any browser settings so the map can consume the full width and height of the browser.

Use dark colors for code blocksCopy
<!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>

  </head>

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

  </body>

</html>

Reference the API

In the <head> tag, add references to the MapLibre GL JS CSS and JS library.

Use dark colors for code blocks
Add line.Add line.
<!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>

    <script src=https://unpkg.com/maplibre-gl@2.4.0/dist/maplibre-gl.js></script>
    <link href=https://unpkg.com/maplibre-gl@2.4.0/dist/maplibre-gl.css rel="stylesheet" />

  </head>

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

  </body>

</html>

Get an 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.

Go to your dashboard to get your API key. You will use it in the next step.

Create a map

Use a Map to add a map to your div with the basemap you specify.

The Map class uses the map HTML element to display the contents of the map and to provide a user interface to interact with. It supports clicking, zooming, panning, rotating, and tilting the perspective of the map. It also allows you to interact with and discover information about the map data such as finding features where the mouse is clicked. You can also use it to modify the data displayed, by adding new sources or changing layer properties.

For more information, see the MapLibre GL JS documentation.

Add a <script>...</script> section at the end of the <body>...</body> section.

Expand
Use dark colors for code blocks
Add line.Add line.Add line.
  <body>
    <div id="map"></div>

    <script>

    </script>

  </body>
Expand

Create an apiKey variable to store your API key. Replace YOUR_API_KEY with the API key you previously copied from the developer dashboard. You will need to include this in the URL of each ArcGIS service you are accessing. You do not need to set mapboxgl.accessToken. Create a basemapEnum variable to store the basemap identifier, ArcGIS:Streets.
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 <script> const apiKey = "YOUR_API_KEY"; const basemapEnum = "ArcGIS:Streets"; </script>
Expand

Create a Map with options to control its display and behavior. Set the container property to the map id of the div you created. The style property references the location of the basemap styles service and contains the basemap identifier and your API key.

Expand
Use dark colors for code blocks
Add line.Add line.Add line.Add line.Add line.Add line.
    <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]
      });

    </script>
Expand

Run the app

In CodePen, run your code to display the map.

The map should display the topographic basemap layer for an area of the Santa Monica Mountains in California.

What's next?

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

Change the basemap style

Switch a basemap style in a map.

Change the place label language

Switch the language of place labels on a basemap.

Display a custom vector tile style

Add a styled vector basemap layer to a map.

Search for an address

Find an address or place using a search box and the geocoding service.

MapLibre GL JS

Display a map

Solution

Estimated time

Related video

Was this page helpful?

How-to video

Was this page helpful?

MapLibre GL JS

Display a map

Prerequisites

Steps

Create a new pen

Add HTML

Reference the API

Get an API key

Create a map

Run the app

What's next?

Change the basemap style

Change the place label language

Display a custom vector tile style

Search for an address

Find a route and directions

Solution

Estimated time

Related video

Was this page helpful?

How-to video

Was this page helpful?