Search with autosuggest

Learn how to search for an address with autosuggest using the geocoding service.

Search for addresses with autosuggest using API key authentication

Autosuggest, also known as autocomplete, is a feature that predicts and displays location-based suggestions as a user types into a search box. In this tutorial, you use ArcGIS REST JS to access the geocoding service. You also create an input control to accept text and suggest address results. When a suggestion is selected, a pop-up will appear with the name, location, and address, and the map will pan to it.

Prerequisites

An ArcGIS Location Platform or ArcGIS Online account.

Steps

Get the starter app

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

You can choose one of the following to create a new CodePen:

Option 1: Complete the Display a scene tutorial; or,
Option 2: Start from the Display a scene tutorial .

Set up authentication

Create 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 and create an API key with the following privilege(s):
- Privileges
  - Location services > Basemaps
  - Location services > Geocoding
Copy the API key access token to your clipboard when prompted.

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

Set the defaultAccessToken included with Cesium to authenticate requests to the ArcGIS services used in this tutorial.

Expand
Use dark colors for code blocks
  <script>

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

    Cesium.ArcGisMapService.defaultAccessToken = accessToken;

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

Set the defaultAccessToken included with Cesium to authenticate requests to the ArcGIS services used in this tutorial.

index.html
Use dark colors for code blocks
    Cesium.ArcGisMapService.defaultAccessToken = accessToken;

Get a Cesium ion access token

All Cesium applications must use an access token provided through Cesium ion. This token allows you to access assets such as Cesium World Terrain in your application.

Go to your Cesium ion dashboard to generate an access token. Copy the key to your clipboard.

Create a cesiumAccessToken variable and replace YOUR_CESIUM_ACCESS_TOKEN with the access token you copied from the Cesium ion dashboard.

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: "YOUR_PORTAL_URL" // Your portal URL
    // })

    // const accessToken = session.token;

    Cesium.ArcGisMapService.defaultAccessToken = accessToken;

    const cesiumAccessToken = "YOUR_CESIUM_ACCESS_TOKEN";

  </script>

Configure Cesium.Ion.defaultAccessToken with the Cesium access token to validate the application.

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: "YOUR_PORTAL_URL" // Your portal URL
    // })

    // const accessToken = session.token;

    Cesium.ArcGisMapService.defaultAccessToken = accessToken;

    const cesiumAccessToken = "YOUR_CESIUM_ACCESS_TOKEN";

    Cesium.Ion.defaultAccessToken = cesiumAccessToken;

  </script>

Add references to ArcGIS REST JS

This tutorial uses ArcGIS REST JS for geocoding. It also uses the ol-popup library to display pop-ups.

In the <head> element, add references to the ArcGIS REST JS request and geocoding libraries.

Use dark colors for code blocks
  <script src="https://cesium.com/downloads/cesiumjs/releases/1.130/Build/Cesium/Cesium.js"></script>
  <link href="https://cesium.com/downloads/cesiumjs/releases/1.130/Build/Cesium/Widgets/widgets.css" rel="stylesheet">

  <script src="https://unpkg.com/@esri/arcgis-rest-request@4/dist/bundled/request.umd.js"></script>
  <script
    src="https://unpkg.com/@esri/arcgis-rest-geocoding@4/dist/bundled/geocoding.umd.js"></script>

Update the scene

Update the scene to center on the coordinates [-123.102, 49.234] with a scale level of 5000. This will center the map on Vancouver.

Expand
Use dark colors for code blocks
    viewer.camera.setView({

      destination: Cesium.Cartesian3.fromDegrees(-123.102, 49.234, 5000),

      orientation: {
        heading: Cesium.Math.toRadians(80),
        pitch: Cesium.Math.toRadians(-40)
      }
    })
Expand

Create geocoding controls

Create an HTML <div> containing an <input> for typing an address and a <button> to clear the input. Then, add a <ul> element to display address suggestions as the user types.

In the <body> of your HTML, add a <ul> element with the id suggestions.

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

  <div class="search">
    <input id="geocode-input" type="text" placeholder="Enter an address or place e.g. 200 Riverside Dr"
      autocomplete="off" />
    <button id="clear-button">&times;</button>
    <ul id="suggestions"></ul>
  </div>

Add styling to the controls.

Use dark colors for code blocks
  <style>
    html,
    body,
    #cesiumContainer {
      width: 100%;
      height: 100%;
      padding: 0px;
      margin: 0px;
    }

    .search {
      position: absolute;
      top: 8px;
      left: 8px;
    }

    #geocode-input {
      font-size: 16px;
      margin: 0 2px 0 0;
      padding: 4px 8px;
      width: 40vw;
    }

    #clear-button {
      position: absolute;
      background: none;
      border: none;
      font-size: 18px;
      color: #666;
      cursor: pointer;
      margin-left: -30px;
      right: 10px;
      top: 5px;
    }

    #suggestions {
      display: none;
      position: absolute;
      background: white;
      list-style: none;
      padding: 0;
      margin: 0;
      width: 40vw;
    }

    #suggestions li {
      padding: 6px 8px;
      border: 1px solid transparent;
      box-sizing: border-box;
    }

    #suggestions li:hover {
      background-color: #f0f0f0;
    }

    #suggestions li.selected {
      border-color: #000;
    }

  </style>

Set up interactivity for the geocoding controls by doing the following:

Handling hover styles.
Enabling keyboard navigation.
Managing suggestion visibility with clear and outside-click actions.

Expand
Use dark colors for code blocks
    const suggestionsList = document.getElementById("suggestions");
    let selectedIndex = -1;

    function updateSelection(items) {
      items.forEach((item, i) => item.classList.toggle("selected", i === selectedIndex));
    }

    input.addEventListener("keydown", (e) => {
      const items = suggestionsList.querySelectorAll("li");
      if (e.key === "ArrowDown") {
        if (selectedIndex < items.length - 1) selectedIndex++;
      } else if (e.key === "ArrowUp") {
        if (selectedIndex > 0) selectedIndex--;
      } else if (e.key === "Enter" && selectedIndex >= 0) {
        items[selectedIndex].click();
      }

      updateSelection(items);
    });

    document.getElementById("clear-button").addEventListener("click", () => {
      input.value = "";
      viewer.entities.remove(candidate);
    });

    document.addEventListener("click", (e) => {
      if (!document.querySelector(".search").contains(e.target)) {
        suggestionsList.style.display = "none";
      }
    });
Expand

Get address suggestions

Use the suggest method from the geocoding service to fetch location suggestions as user types.

Add an input event handler to capture text as the user types. Reset the selection index and hide suggestions when the input is empty.

Expand
Use dark colors for code blocks
    input.addEventListener("input", () => {
      selectedIndex = -1;
      const text = input.value;
      if (!text) {
        suggestionsList.stylex.display = "none";
        return;
      }

    });
Expand

Use the suggest method to fetch location suggestions as the user types, then display them in a list. For each suggestion, create an <li> element, append it to the suggestions list, and make the list visible.

Expand
Use dark colors for code blocks
    input.addEventListener("input", () => {
      selectedIndex = -1;
      const text = input.value;
      if (!text) {
        suggestionsList.stylex.display = "none";
        return;
      }

      arcgisRest.suggest(text, {
        authentication,
        params: {
          location: {
            x: -123.102,
            y: 49.234,
            spatialReference: { wkid: 4326 }
          },
          maxSuggestions: 5
        }
      }).then((response) => {
        suggestionsList.innerHTML = "";
        if (!response.suggestions || response.suggestions.length === 0) {
          suggestionsList.style.display = "none";
          return;
        }

        response.suggestions.forEach((s) => {
          const li = document.createElement("li");
          li.textContent = s.text;

          suggestionsList.appendChild(li);
        });
        suggestionsList.style.display = "block";
      });

    });
Expand

Call the `geocode` method

When the user selects a suggestion, call the geocode method to get location coordinates.

Get the input field and initialize the entity.

Expand
Use dark colors for code blocks
    const input = document.getElementById("geocode-input");
    let candidate;
Expand

Use your access token to authenticate with ArcGIS REST JS and make requests to the geocoding service.

Expand
Use dark colors for code blocks
    const authentication = arcgisRest.ApiKeyManager.fromKey(accessToken);
Expand

Create a function that calls geocode using the magicKey returned by the suggest method. The magicKey helps match partial text input to a complete address. You will use this function in a later step.

Expand
Use dark colors for code blocks
    function performGeocode(magicKey) {
      arcgisRest.geocode({
        magicKey,
        authentication
      }).then((response) => {
        const result = response.candidates[0];
        const location = Cesium.Cartesian3.fromDegrees(result.location.x, result.location.y);

      })
    }
Expand

Add a click handler to each suggestion item to call the performGeocode function with the suggestion's magicKey.

Expand
Use dark colors for code blocks
          li.addEventListener("click", () => {
            input.value = s.text;
            suggestionsList.style.display = "none";
            performGeocode(s.magicKey)
          });
Expand

Show the result

Place a custom PinBuilder on the scene, display the location details in a a billboard Entity, and smoothly pan the camera to that point.

Show the location details with an entity, a PinBuilder, and pan the scene to the location.

Expand
Use dark colors for code blocks
    function performGeocode(magicKey) {
      arcgisRest.geocode({
        magicKey,
        authentication
      }).then((response) => {
        const result = response.candidates[0];
        const location = Cesium.Cartesian3.fromDegrees(result.location.x, result.location.y);

        const pinBuilder = new Cesium.PinBuilder();

        candidate = viewer.entities.add({
          name: `${result.address}`,
          description: `${result.location.x.toFixed(4)}, ${result.location.y.toFixed(4)}`,
          position: location,
          billboard: {
            verticalOrigin: Cesium.VerticalOrigin.BOTTOM,
            heightReference: Cesium.HeightReference.CLAMP_TO_GROUND,
            image: pinBuilder.fromColor(Cesium.Color.fromCssColorString('#5491f5'), 48).toDataURL()
          }
        });

        viewer.selectedEntity = candidate;
        viewer.trackedEntity = candidate;
        viewer.camera.flyTo({
          destination: location,
          duration: 1
        });

      })
    }
Expand

Run the app

Run the app.

In the input box, type a partial address and see the suggestions come up. Click on a suggestion and the scene will pan to the geocoded address and show a popup with the address details.

What's next?

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

Search for an address

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

Reverse geocode

Find an address near a location with the Geocoding service.

Find nearby places and details

Find points of interest near a location and get detailed information about them