Display basemap places | OpenLayers

Learn how to show places on a basemap.

Display basemap places using API key authentication

The ArcGIS Basemap Styles service allows you to show or hide place locations in a basemap style. The places represent businesses, services, landmarks, and other places of interest (POIs) all over the world. When places are active, each is displayed with an icon and a name label.

In this tutorial, you set the basemap style preferences to show places and return place details from the ArcGIS Places service with ArcGIS REST JS.

Prerequisites

You need an ArcGIS Location Platform account.

Steps

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

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 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
  - Location services > Places

Set developer credentials

Use the API key or OAuth developer credentials so your application can access ArcGIS services.

Update the accessToken variable to use your API key.

Expand
Use dark colors for code blocks
    /* 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 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!

Display attributed places

The arcgis/navigation style contains a set of places that show up on the map based on the current zoom level and extent. The places displayed can be refined with the places parameter to show all places, no places, or places with attributes. The main attributes returned with the attributed value are name and esri_place_id.

Update the basemap style to arcgis/navigation and set style preferences to display places by appending &places=attributed in the basemap URL.

Expand
Use dark colors for code blocks
    const basemapId = "arcgis/navigation";
    const basemapURL = `https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/${basemapId}?token=${accessToken}&places=attributed`;
Expand

Change the map's viewpoint to [-118.46651, 33.98621] with a zoom of 16 to focus on West Hollywood, California.

Expand
Use dark colors for code blocks
    const map = new ol.Map({ target: "map" });

    map.setView(
      new ol.View({

        center: ol.proj.fromLonLat([-118.33873, 34.10151]),
        zoom: 16

      })
    );

    const basemapId = "arcgis/navigation";
    const basemapURL = `https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/${basemapId}?token=${accessToken}&places=attributed`;
Expand

Add script references

Each attributed place contains an esri_place_id. You can use the place ID with ArcGIS REST JS to call the Places service place/placeId operation and get additional attributes. You can display the place information with the ol-popup and Calcite libraries.

Reference the request and places packages from ArcGIS REST JS, the ol-popup, and the Calcite Components libraries.

Use dark colors for code blocks
    <!-- Load ArcGIS REST JS -->
    <script src="https://unpkg.com/@esri/arcgis-rest-request@4/dist/bundled/request.umd.js"></script>
    <script
      src="https://unpkg.com/@esri/arcgis-rest-places@1/dist/bundled/places.umd.js"></script>
    <!-- Calcite components -->
    <script type="module" src="https://js.arcgis.com/calcite-components/2.12.1/calcite.esm.js"></script>
    <link rel="stylesheet" href="https://js.arcgis.com/calcite-components/2.12.1/calcite.css">
    <!-- OpenLayers popup -->
    <script src="https://unpkg.com/ol-popup@5.1.1/dist/ol-popup.js"></script>
    <link rel="stylesheet" href="https://unpkg.com/ol-popup@5.1.1/src/ol-popup.css">

Update interface

Create an HTML results panel using the <calcite-panel> and <calcite-block> elements. This panel will be hidden by default, and display when place details are returned from the Places service.

Inside <body>, copy and paste the following HTML to create a basic results panel that is hidden by default.

Use dark colors for code blocks
    <div id="map"></div>

    <calcite-panel id="panelPlace" closable hidden>
      <calcite-block
        id="addressLabel"
        class="hide"
        heading="Address"
        scale="l"
      >
        <calcite-icon slot="icon" icon="map-pin"></calcite-icon>
      </calcite-block>
      <calcite-block
        id="phoneLabel"
        class="hide"
        heading="Phone"
        scale="l"
      >
        <calcite-icon slot="icon" icon="mobile"></calcite-icon>
      </calcite-block>
      <calcite-block
        id="emailLabel"
        class="hide"
        heading="Email"
        scale="l"
      >
        <calcite-icon slot="icon" icon="email-address"></calcite-icon>
      </calcite-block>
      <calcite-block
        id="websiteLabel"
        class="hide"
        heading="Website"
        scale="l"
      >
        <calcite-icon slot="icon" icon="information"></calcite-icon>
      </calcite-block>
      <calcite-block
        id="facebookLabel"
        class="hide"
        heading="Facebook"
        scale="l"
      >
        <calcite-icon slot="icon" icon="speech-bubble-social"></calcite-icon>
      </calcite-block>
      <calcite-block
        id="twitterLabel"
        class="hide"
        heading="Twitter"
        scale="l"
      >
        <calcite-icon slot="icon" icon="speech-bubbles"></calcite-icon>
      </calcite-block>
      <calcite-block
        id="instagramLabel"
        class="hide"
        heading="Instagram"
        scale="l"
      >
        <calcite-icon slot="icon" icon="camera"></calcite-icon>
      </calcite-block>
    </calcite-panel>

Add styling for the results panel.

Use dark colors for code blocks
      #panelPlace {
        position: absolute;
        top: 10px;
        right: 10px;
        width: 350px;
        height: calc(100% - 75px);
      }

      .hide {
        display: none;
      }

Get place details

When a user hovers over a POI, display a popup with the place's name and ID. When a user clicks on a POI, use the getPlaceDetails method from ArcGIS REST JS to request detailed attributes for the selected place and display them in a Calcite panel.

Initialize a Popup object and add it to the map as an overlay.

Expand
Use dark colors for code blocks
    const popup = new Popup({ autoPan: false });

    map.addOverlay(popup);

Expand

Listen for the pointermove event on the map. Use forEachFeatureAtPixel to get the feature under the mouse. If the feature contains esri_place_id, show a popup with the place's information.

Expand
Use dark colors for code blocks
    const popup = new Popup({ autoPan: false });

    map.addOverlay(popup);

    map.on("pointermove", function (e) {
      if (e.dragging) return;

      const feature = map.forEachFeatureAtPixel(e.pixel, (f) => f);
      if (feature && feature.get("esri_place_id")) {
        map.getTargetElement().style.cursor = "pointer";
        popup.show(
          e.coordinate,
          `<b>Place ID:</b> ${feature.get("esri_place_id")}`
        );
      } else {
        map.getTargetElement().style.cursor = "";
        popup.hide();
      }
    });
Expand

Listen for the click event on the feature. Store its properties and make the Calcite panel visible.

Expand
Use dark colors for code blocks
    const panel = document.getElementById("panelPlace");

    map.on("click", function (evt) {
      let placeFeature = null;

      map.forEachFeatureAtPixel(evt.pixel, function (feature) {
        const props = feature.getProperties();
        if (props.esri_place_id) {
          placeFeature = props;
        }
      });

      if (placeFeature) {
        const placeId = placeFeature.esri_place_id;
        panel.hidden = false;
        panel.closed = false;

    });
Expand

Use the ArcGIS REST JS getPlaceDetails method to fetch detailed information for that place.

Expand
Use dark colors for code blocks
    const panel = document.getElementById("panelPlace");

    map.on("click", function (evt) {
      let placeFeature = null;

      map.forEachFeatureAtPixel(evt.pixel, function (feature) {
        const props = feature.getProperties();
        if (props.esri_place_id) {
          placeFeature = props;
        }
      });

      if (placeFeature) {
        const placeId = placeFeature.esri_place_id;
        panel.hidden = false;
        panel.closed = false;

        arcgisRest.getPlaceDetails({
          placeId,
          requestedFields: "all",
          authentication
        }).then((response) => {
          const details = response.placeDetails;
          setPlaceDetails(details);
        });
      }

    });
Expand

Create a showPlaceDetails to populate the Calcite panel with attributes from the Places service response. Add a listener for the panel’s calcitePanelClose event to hide it when closed.

Expand
Use dark colors for code blocks
    function setPlaceDetails(placeDetails) {
      panel.setAttribute("heading", placeDetails.name);

      setElement("addressLabel", placeDetails?.address?.streetAddress);
      setElement("phoneLabel", placeDetails?.contactInfo?.telephone);
      setElement("emailLabel", placeDetails?.contactInfo?.email);
      setElement("websiteLabel", placeDetails?.contactInfo?.website?.split("://")[1]?.split("/")[0]);
      setElement("facebookLabel", placeDetails?.socialMedia?.facebookId ? `facebook.com/${placeDetails.socialMedia.facebookId}` : null);
      setElement("twitterLabel", placeDetails?.socialMedia?.twitter ? `twitter.com/${placeDetails.socialMedia.twitter}` : null);
      setElement("instagramLabel", placeDetails?.socialMedia?.instagram ? `instagram.com/${placeDetails.socialMedia.instagram}` : null);

      panel.addEventListener("calcitePanelClose", function () {
        panel.hidden = true;
        panel.closed = true;
      });
    }
Expand

Create a helper function setElement that updates each Calcite label’s visibility and description. This ensures that only fields with values are displayed in the panel.

Expand
Use dark colors for code blocks
    function setElement(id, value) {
      const el = document.getElementById(id);
      if (value) {
        el.classList.remove("hide");
        el.description = value;
      } else {
        el.classList.add("hide");
        el.description = "";
      }
    }
Expand

Run the app

Run the app.

The map should display the arcgis/navigation basemap style with attributed places. When you hover over a place, a popup should appear that contains the place name and ID. When you click on a POI, the Places service returns details about it.

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.

Find places in a bounding box

Perform a text-based search to find places within a bounding box.

Find nearby places and details

Find places near a location and get detailed place information.