Display a map

Learn how to use Esri Leaflet 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 basemap styles service. A vector tile basemap layer contains the styles, 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. The code is used as the starting point for the other Esri Leaflet tutorials.

Prerequisites

An ArcGIS Location Platform or ArcGIS Online account.

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

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
<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 developer credentials in your portal for the type of authentication you selected.

Create a new API key credential with 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
When prompted, copy and paste the API key to a safe location. It will be used in the next step.

Set developer credentials

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

Add <script> elements 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
    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.16/dist/esri-leaflet.js"></script>

  <script src="https://unpkg.com/esri-leaflet-vector@4.3.0/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 the list of default basemap styles, go to 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 34.02, -118.805 and to set the zoom level to 13.

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

    map.setView([34.02, -118.805], 13);

Expand

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

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

    map.setView([34.02, -118.805], 13);

    const basemapEnum = "arcgis/streets";

Expand

Instantiate the 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/streets";

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

Run the app

Run the app.

The map should display a street basemap layer centered on Point Dume in California.

What's next?

Learn how to use additional ArcGIS Location Services in these tutorials:

Change language labels for basemap styles

Switch the language of place labels on a basemap.

Display a custom basemap 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.

Find a route and directions

Find a route and directions with the route service.