Display a map | Esri Leaflet

Learn how to display a map.

Display a map using API key authentication

You can display a map with Esri Leaflet by using a vector tile basemap layer from the ArcGIS Basemap Styles service. A vector tile basemap layer contains the styles, layers, font glyphs, and icons to render the layers.

In this tutorial, display a map of the world with the arcgis/outdoor basemap style.

This application will use the basemap tiles usage model .

Prerequisites

You need an ArcGIS Location Platform or ArcGIS Online account.

Steps

Create a new 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 applications that access ArcGIS Location Services and secure items.
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 account and access resources their behalf.
Have an ArcGIS Online account.

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

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 dark colors for code blocks
<!DOCTYPE html>
<html lang="en">


  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no">
    <title>Esri Leaflet Tutorials: Display a map</title>

    <style>
    body {
      margin: 0;
      padding: 0;
    }

    #map {
      position: absolute;
      top: 0;
      bottom: 0;
      right: 0;
      left: 0;
      font-family: Arial, Helvetica, sans-serif;
      font-size: 14px;
      color: #323232;
    }
    </style>
  </head>


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

  </body>


</html>

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
  <body>

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

Apply CSS styling to the map div.

Use dark colors for code blocks
    body {
      margin: 0;
      padding: 0;
    }

    #map {
      position: absolute;
      top: 0;
      bottom: 0;
      right: 0;
      left: 0;
      font-family: Arial, Helvetica, sans-serif;
      font-size: 14px;
      color: #323232;
    }

Set up authentication

Create a new API key credential with the correct privileges to get an access token.

Go to the Create an API key tutorial and create an API key with the following privilege(s):
- Privileges
  - Location services > Basemaps

Set the developer credentials

Use the access token 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

Use the OAuth credentials created in the previous step in your application.

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
    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!

Add script references

To access vector basemap layers, you need to reference the leaflet libraries as well as the esri-leaflet and esri-leaflet-vector plugins.

In the index.html file, add the following <link> and <script> references if they are missing.

Use dark colors for code blocks

  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no">
    <title>Esri Leaflet Tutorials: Display a map</title>

    <!-- Load Leaflet from CDN -->
    <link rel="stylesheet" href="https://unpkg.com/leaflet@1.9.4/dist/leaflet.css" crossorigin="">
    <script src="https://unpkg.com/leaflet@1.9.4/dist/leaflet.js" crossorigin=""></script>
    <!-- Load Esri Leaflet from CDN -->
    <script src="https://unpkg.com/esri-leaflet@3.0.19/dist/esri-leaflet.js"></script>

    <script src="https://unpkg.com/esri-leaflet-vector@4.3.2/dist/esri-leaflet-vector.js"></script>

Create a map

Use a map to add a map to the div element with the basemap you specify. To find a list of basemap styles, go to Introduction to the Basemap Styles service .

In the <script> tag, create a map with the minZoom set to 2.

Expand
Use dark colors for code blocks
      const map = L.map("map", {
        minZoom: 2
      });

Expand

Call the setView method to center the map on the coordinates 30, -20 and to set the zoom level to 3.

Expand
Use dark colors for code blocks
      const map = L.map("map", {
        minZoom: 2
      });

      map.setView([30, -20], 3);

Expand

Create a basemapEnum variable to store the basemap identifier, arcgis/outdoor.

Expand
Use dark colors for code blocks
      const map = L.map("map", {
        minZoom: 2
      });

      map.setView([30, -20], 3);

      const basemapEnum = "arcgis/outdoor";

Expand

Instantiate the L.esri.Vector.vectorBasemapLayer class and set the basemapEnum and accessToken before adding the layer to the map.

Expand
Use dark colors for code blocks
      const basemapEnum = "arcgis/outdoor";

      L.esri.Vector.vectorBasemapLayer(basemapEnum, {
        token: accessToken
      }).addTo(map);
Expand

Run the app

Run the app.

The map should display the Outdoor basemap layer centered on the world.

What's next?

Learn how to use additional location services in these tutorials:

Change language labels

Switch the language of place labels on a basemap.

Display a custom basemap style

Add a custom vector basemap style to a map.

Search for an address

Find an address or place using a search box.

Find a route and directions

Find a route and directions from a start and finish location.