Tutorial: Get local data | CesiumJS

Learn how to access local data, such as spending trends, for the United States.

Get local data using API key authentication

The ArcGIS GeoEnrichment service provides detailed local data for specific countries. Each individual data field is represented by an analysis variable that are organized into data categories such as spending and market behaviors such as 2022 Educational Attainment or 2022 Seen Video Ad at Gas Station Last 30 Days. The data available vary by country and by data provider.

In this tutorial, use ArcGIS REST JS to access the GeoEnrichment service and display spending trend information for a study area within the United States.

Prerequisites

You need an ArcGIS Location Platform or ArcGIS Online 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 scene tutorial; or,
Option 2: Start from the Display a scene 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 > Data enrichment

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

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

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!

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

In the <head> element, reference the demographics and request packages from ArcGIS REST JS.

Expand
Use dark colors for code blocks
    <script src="https://cesium.com/downloads/cesiumjs/releases/1.134/Build/Cesium/Cesium.js"></script>
    <link href="https://cesium.com/downloads/cesiumjs/releases/1.134/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-demographics@4/dist/bundled/demographics.umd.js"></script>
Expand

Update the map position

Local data is only available in select countries and regions. Update the camera position to center on Nashville, Tennessee.

Update the camera destination to [-86.7679, 36.1345, 15000], Nashville TN.

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

        destination: Cesium.Cartesian3.fromDegrees(-86.7679, 36.1345, 15000),
        orientation: {
          heading: Cesium.Math.toRadians(0.0),
          pitch: Cesium.Math.toRadians(-80.0)

        }
      });
Expand

Add a click event handler

The study area for your application will be a one-mile buffer around a clicked location. Add an event handler that listens for left clicks on the map and retrieves their coordinates.

Add an event listener to the viewer's ScreenSpaceEventHandler that listens for left clicks.

Expand
Use dark colors for code blocks
        destination: Cesium.Cartesian3.fromDegrees(-86.7679, 36.1345, 15000),
        orientation: {
          heading: Cesium.Math.toRadians(0.0),
          pitch: Cesium.Math.toRadians(-80.0)

        }
      });

      // Add Esri attribution
      // Learn more in https://esriurl.com/attribution
      const poweredByEsri = new Cesium.Credit("Powered by <a href='https://www.esri.com/en-us/home' target='_blank'>Esri</a>", true);
      viewer.creditDisplay.addStaticCredit(poweredByEsri);

      viewer.screenSpaceEventHandler.setInputAction(function (movement) {

      }, Cesium.ScreenSpaceEventType.LEFT_CLICK);
Expand

Retrieve the coordinates of the left click and convert them to Cartographic latitude and longitude. Pass the coordinates to a new function called getLocalData that accepts coordinates as degrees.

Expand
Use dark colors for code blocks
        destination: Cesium.Cartesian3.fromDegrees(-86.7679, 36.1345, 15000),
        orientation: {
          heading: Cesium.Math.toRadians(0.0),
          pitch: Cesium.Math.toRadians(-80.0)

        }
      });

      // Add Esri attribution
      // Learn more in https://esriurl.com/attribution
      const poweredByEsri = new Cesium.Credit("Powered by <a href='https://www.esri.com/en-us/home' target='_blank'>Esri</a>", true);
      viewer.creditDisplay.addStaticCredit(poweredByEsri);

      function getLocalData(longitude, latitude) {

      }

      viewer.screenSpaceEventHandler.setInputAction(function (movement) {

        const pickedPosition = viewer.scene.pickPosition(movement.position);
        const cartographic = Cesium.Cartographic.fromCartesian(pickedPosition);

        getLocalData(Cesium.Math.toDegrees(cartographic.longitude), Cesium.Math.toDegrees(cartographic.latitude));

      }, Cesium.ScreenSpaceEventType.LEFT_CLICK);
Expand

Execute the query

Execute the queryDemographicData operation to retrieve local data. To query a circular buffer around a point, pass a geometry object with x and y coordinates. The default search radius is one mile.

Create a new ApiKeyManager using your access token to authenticate requests to the GeoEnrichment service.

Expand
Use dark colors for code blocks
      /* 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 authentication = arcgisRest.ApiKeyManager.fromKey(accessToken);
Expand

Access the GeoEnrichment service with queryDemographicData. Set the studyAreas parameter to a point geometry made from the passed longitude and latitude. Also pass the authentication object.

Expand
Use dark colors for code blocks
      function getLocalData(longitude, latitude) {

        arcgisRest
          .queryDemographicData({
            studyAreas: [{ geometry: { x: longitude, y: latitude } }],
            authentication: authentication,

          })

      }
Expand

Set the analysisVariables parameter with the following analysis variables:

Buys Natural Products (PsychographicsShopping.MP28067A_B)
Auto/Truck Rental on Trips (transportation.X7027_I)
Membership fees for Social Clubs (entertainment.X9005_I)

Expand
Use dark colors for code blocks
      function getLocalData(longitude, latitude) {

        arcgisRest
          .queryDemographicData({
            studyAreas: [{ geometry: { x: longitude, y: latitude } }],
            authentication: authentication,

            analysisVariables: ["PsychographicsShopping.MP28067A_B", "transportation.X7027_I", "entertainment.X9005_I"]

          })

      }
Expand

Display results

If the query is successful, the response will contain a results array with a value containing a FeatureSet. The FeatureSet contains values representing the prevalence of each specified analysis variable in the provided study area. A message will display if there is no data available for a location selected.

Access the FeatureSet returned by the service response. If data was returned, access the feature attributes to create a message.

Expand
Use dark colors for code blocks
            analysisVariables: ["PsychographicsShopping.MP28067A_B", "transportation.X7027_I", "entertainment.X9005_I"]

          })

          .then((response) => {
            const featureSet = response.results[0].value.FeatureSet;
            let message;

            if (featureSet.length > 0 && featureSet[0].features.length > 0) {
              const attributes = featureSet[0].features[0].attributes;
              message =
                "<b>Data for a 1 mile search radius</b><br>" +
                [
                  `Buys Natural Products: ${attributes.MP28067a_B}`,
                  `Membership fees for Social Clubs: ${attributes.X9005_I}`,
                  `Auto/Truck Rental on Trips: ${attributes.X7027_I}`
                ].join("<br>");

            } else {
              message = "Data not available for this location.";
            }

          });
Expand

Create a new Entity to display the results. Set the position to the clicked location, and set the description to the message you created.

Expand
Use dark colors for code blocks
            } else {
              message = "Data not available for this location.";
            }

            let resultEntity = new Cesium.Entity({
              name: "Demographic results",
              description: message,
              position: Cesium.Cartesian3.fromDegrees(longitude, latitude)
            });

            viewer.selectedEntity = resultEntity;
Expand

Run the app

Run the app.

You should now see a map centered over Nashville. Click on the map to access the GeoEnrichment service to return local information and view the results in a popup.

What's next?

Learn how to use additional location services in these tutorials:

Get global data

Query demographic information for locations around the world.

Search for an address

Find an address or place using a search box.

Query features (SQL)

Execute a SQL query to access polygon features from a feature service.