Tutorial: Display a scene | CesiumJS

Learn how to display a scene with styled basemap tiles.

Display a scene using API key authentication

You can display a CesiumJS with ArcGIS styled basemap tiles. The ArcGIS Static Basemap Tiles service provides basemap data as pre-styled raster tiles for the world. The service provides styles from the ArcGIS Basemap style family that are grouped into categories such as streets, topography, reference, and creative.

In this tutorial, you display the arcgis/navigation basemap style provided by the service.

Prerequisites

You need an ArcGIS Location Platform account.

ArcGIS Online and ArcGIS Enterprise accounts are not supported.

Steps

Create a new 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.

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

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

  <head>

    <meta charset="utf-8">
    <title>CesiumJS: Display a Scene</title>

    <style>
    html,
    body,
    #cesiumContainer {
      margin: 0;
      padding: 0;
      width: 100%;
      height: 100%;
    }
    </style>
  </head>


  <body>

    <div id="cesiumContainer"></div>

  </body>

</html>

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

Use dark colors for code blocks

  <body>

    <div id="cesiumContainer"></div>

Apply CSS styling to the cesiumContainer div.

Use dark colors for code blocks
    html,
    body,

    #cesiumContainer {
      margin: 0;
      padding: 0;
      width: 100%;
      height: 100%;
    }

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

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

In the index.html file, add the following <link> and <script> references if they are missing.

Use dark colors for code blocks
    <meta charset="utf-8">
    <title>CesiumJS: Display a Scene</title>

    <script src="https://cesium.com/downloads/cesiumjs/releases/1.135/Build/Cesium/Cesium.js"></script>
    <link href="https://cesium.com/downloads/cesiumjs/releases/1.135/Build/Cesium/Widgets/widgets.css" rel="stylesheet">

Create a scene

Set up your CesiumJS scene by creating a viewer and positioning the camera over the United States of America.

Create a Viewer attached to the cesiumContainer element. Disable the timeline, animation, and geocoder controls.

Expand
Use dark colors for code blocks
      const viewer = new Cesium.Viewer("cesiumContainer", {
        baseLayerPicker: false,
        timeline: false,
        animation: false,
        geocoder: false
      });
Expand

Use viewer.camera.setView to set the camera's position and extent to the United States of America.

Expand
Use dark colors for code blocks
      viewer.camera.setView({
        destination: Cesium.Cartesian3.fromDegrees(-91.2996, 37.1174, 12000000)
      });
Expand

Add imagery provider

Use UrlTemplateImageryProvider to add a raster basemap from the Static Basemap Tiles service.

Create a basemapEnum variable and construct the base service URL.

Expand
Use dark colors for code blocks
      const basemapEnum = "arcgis/navigation";
      const baseUrl = `https://static-map-tiles-api.arcgis.com/arcgis/rest/services/static-basemap-tiles-service/v1/${basemapEnum}/static`;

Expand

Create the imagery provider with UrlTemplateImageryProvider.

Expand
Use dark colors for code blocks
      const basemapEnum = "arcgis/navigation";
      const baseUrl = `https://static-map-tiles-api.arcgis.com/arcgis/rest/services/static-basemap-tiles-service/v1/${basemapEnum}/static`;

      const imageryProvider = new Cesium.UrlTemplateImageryProvider({
        url: `${baseUrl}/tile/{z}/{y}/{x}?token=${accessToken}`,
        tileWidth: 512,
        tileHeight: 512
      });
Expand

Add it to the viewer's imageryLayers.

Expand
Use dark colors for code blocks
      viewer.imageryLayers.addImageryProvider(imageryProvider);
Expand

Add attribution

You need to display Esri and data attribution in all applications that use Esri technology.

Create a new Credit for the Powered by Esri string with showOnScreen set to true and then add it to the viewer.

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

Run the app

Run the app.

The map should display the arcgis/navigation base layer centered on the United States of America.

What's next?

Learn how to use additional location services in these tutorials:

Change the base layer

Change the imagery and terrain layers in a scene.

Add features as GeoJSON

Add features from a feature service to a scene.

Add 3D objects

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