Tutorial: Display a 3D object pop-up

Learn how to display attributes of 3D objects in a pop-up when clicked.

Display attributes of 3D objects using API key authentication

A pop-up, also known as a "popup", is a visual element that displays information about an object when it is clicked. You typically style and configure a pop-up using HTML and CSS for each layer in a map. Pop-ups can display attribute values, calculated values, or rich content such as images, charts, or videos.

In this tutorial, you customize the interactive pop-up created by CesiumJS for the San Francisco Buildings 3D object layer. When a building is clicked, a pop-up is displayed containing the name of the building and its object ID.

Prerequisites

An ArcGIS Location Platform or ArcGIS Online account.

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
- Item access
  - Note: If you are using your own custom data layer for this tutorial, you need to grant the API key credentials access to the layer item. Learn more in Item access privileges.
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
    const session = await arcgisRest.ArcGISIdentityManager.beginOAuth2({
      clientId: "YOUR_CLIENT_ID", // Your client ID from OAuth credentials
      redirectUri: "YOUR_REDIRECT_URL", // The redirect URL registered in your OAuth credentials
      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_URL", // 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_URL", // 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_URL", // 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>

Code

Use dark colors for code blocksCopy
<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="utf-8" />
  <title>CesiumJS: Display a 3D object layer popup</title>
  <!-- Include the CesiumJS JavaScript and CSS files -->
  <script src="https://cesium.com/downloads/cesiumjs/releases/1.121/Build/Cesium/Cesium.js"></script>
  <link href="https://cesium.com/downloads/cesiumjs/releases/1.121/Build/Cesium/Widgets/widgets.css" rel="stylesheet">
  <style>
    html,
    body {

      margin: 0px;
      padding: 0px;
      height: 100%;
    }

    #cesiumContainer {
      height: 100%;
    }
  </style>
</head>

<body>
  <div id="cesiumContainer"></div>
  <script type="module">

    /* 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_URL", // 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;

    const arcGisImagery = Cesium.ArcGisMapServerImageryProvider.fromBasemapType(Cesium.ArcGisBaseMapType.SATELLITE, {
      enablePickFeatures: false
    });

    const viewer = new Cesium.Viewer("cesiumContainer", {

      baseLayer: Cesium.ImageryLayer.fromProviderAsync(arcGisImagery),

      terrain: Cesium.Terrain.fromWorldTerrain(),
      timeline: false,
      animation: false,
      geocoder: false

    });

    viewer.camera.setView({
      destination: Cesium.Cartesian3.fromDegrees(-122.43305, 37.77655, 500),
      orientation: {
        heading: Cesium.Math.toRadians(60),
        pitch: Cesium.Math.toRadians(-15.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);

    const geoidService = await Cesium.ArcGISTiledElevationTerrainProvider.fromUrl("https://tiles.arcgis.com/tiles/GVgbJbqm8hXASVYi/arcgis/rest/services/EGM2008/ImageServer");

    const i3sLayer = "https://tiles.arcgis.com/tiles/z2tnIkrLQ2BRzr6P/arcgis/rest/services/SanFrancisco_Bldgs/SceneServer";

    const i3sProvider = await Cesium.I3SDataProvider.fromUrl(i3sLayer, {
      geoidTiledTerrainProvider: geoidService,
      token: accessToken,
    })
    // Attribution text retrieved from https://www.arcgis.com/home/item.html?id=d3344ba99c3f4efaa909ccfbcc052ed5
    viewer.creditDisplay.addStaticCredit(new Cesium.Credit("Precision Light Works (PLW)", false));

    viewer.scene.primitives.add(i3sProvider);

    // An entity object which will hold info about the currently selected feature for infobox display
    const selectedEntity = new Cesium.Entity();
    // Show metadata in the InfoBox.
    viewer.screenSpaceEventHandler.setInputAction(function onLeftClick(movement) {
      // Pick a new feature
      const pickedFeature = viewer.scene.pick(movement.position);
      if (!Cesium.defined(pickedFeature)) {
        return;
      }
      const pickedPosition = viewer.scene.pickPosition(movement.position);

      if (
        Cesium.defined(pickedFeature.content) &&
        Cesium.defined(pickedFeature.content.tile.i3sNode)
      ) {
        const i3sNode = pickedFeature.content.tile.i3sNode;

        i3sNode.loadFields().then(function () {
          const geometry = i3sNode.geometryData[0];
          if (pickedPosition) {
            const location = geometry.getClosestPointIndexOnTriangle(
              pickedPosition.x,
              pickedPosition.y,
              pickedPosition.z
            );
            let description = "No attributes";
            let name;
            if (location.index !== -1 && geometry.customAttributes.featureIndex) {
              const featureIndex =
                geometry.customAttributes.featureIndex[location.index];
              if (Object.keys(i3sNode.fields).length > 0) {
                description =
                  '<table class="cesium-infoBox-defaultTable"><tbody>';
                for (const fieldName in i3sNode.fields) {
                  if (i3sNode.fields.hasOwnProperty(fieldName)) {
                    const field = i3sNode.fields[fieldName];
                    description += `<tr><th>${field.name}</th><td>`;
                    description += `${field.values[featureIndex]}</td></tr>`;
                    console.log(
                      `${field.name}: ${field.values[featureIndex]}`
                    );
                    if (
                      !Cesium.defined(name) &&
                      isNameProperty(field.name)
                    ) {
                      name = field.values[featureIndex];
                    }
                  }
                }
                description += `</tbody></table>`;
              }
            }
            if (!Cesium.defined(name)) {
              name = "unknown";
            }
            selectedEntity.name = name;
            selectedEntity.description = description;
            viewer.selectedEntity = selectedEntity;
          }
        });
      }

    },
      Cesium.ScreenSpaceEventType.LEFT_CLICK);

    function isNameProperty(propertyName) {
      const name = propertyName.toLowerCase();
      if (
        name.localeCompare("name") === 0 ||
        name.localeCompare("objname") === 0
      ) {
        return true;
      }
      return false;
    }
  </script>
</body>

</html>

What's next?

Learn how to use additional ArcGIS location services in these tutorials:

Add 3D objects

Add 3D objects from a scene service to a scene.

Display a pop-up (Feature)

Display feature attributes in a popup.

Search for an address

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