Tutorial: Style features | CesiumJS

Learn how to use data-driven styling to apply symbol colors and styles to feature layers.

Style a feature layer using API key authentication

A feature layer is a dataset in a feature service hosted in ArcGIS. Each feature layer contains features with a single geometry type (point, line, or polygon), and a set of attributes.

In this tutorial, you apply different styles to enhance the visualization of the Trailheads, Trails, and Parks and Open Spaces feature layers.

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

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 feature-service 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-feature-service@4/dist/bundled/feature-service.umd.js"></script>

Expand

In the <body>, create an arcgisRest.ApiKeyManager using your access token to authenticate requests to the feature 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

Remove the terrain provider

CesiumJS does not currently fully support layer styling in scenes with terrain.

Remove the terrainProvider from your viewer to enable layer ordering and feature outlines.

Use dark colors for code blocks
        const viewer = new Cesium.Viewer("cesiumContainer", {

            imageryProvider: arcGISImageTileProvider,

            terrainProvider: Cesium.createWorldTerrain(),

            timeline: false,
            animation: false,

            geocoder:false

        });

Style trailheads (points) with icons

To style a point feature layer with custom icons, add the layer as a GeoJsonDataSource and iterate through each Entity created by the layer. Set the Billboard property to style the points with trailhead icons.

Use arcgisRest.queryFeatures to make an authenticated request to the Trailheads URL. Format the response as GeoJSON, then add it to your scene as a GeoJsonDataSource.

Expand
Use dark colors for code blocks
    const pointLayerURL = "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Trailheads/FeatureServer/0";

    arcgisRest.queryFeatures({
      url: pointLayerURL,
      authentication,
      f: "geojson"
    }).then((response) => {
      Cesium.GeoJsonDataSource.load(response, {
        clampToGround: true,

      }).then((dataSource) => {
        dataSource.name = "trailheads";
        viewer.dataSources.add(dataSource);

      });
    });
Expand

Add the data attribution for the feature layer source.

Go to the Trailheads (Santa Monica Mountains) item.
Scroll down to the Acknowledgments section and copy its value.

Paste the copied value to the credit property.

Expand
Use dark colors for code blocks
    const pointLayerURL = "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Trailheads/FeatureServer/0";

    arcgisRest.queryFeatures({
      url: pointLayerURL,
      authentication,
      f: "geojson"
    }).then((response) => {
      Cesium.GeoJsonDataSource.load(response, {
        clampToGround: true,

        // Attribution text retrieved from https://arcgis.com/home/item.html?id=883cedb8c9fe4524b64d47666ed234a7
        credit: "Los Angeles GeoHub"

      }).then((dataSource) => {
        dataSource.name = "trailheads";
        viewer.dataSources.add(dataSource);

      });
    });
Expand

After the layer is loaded, iterate through each Entity in the layer and set each Billboard image to the URL for the hiker icon: http://static.arcgis.com/images/Symbols/NPS/npsPictograph_0231b.png.

Expand
Use dark colors for code blocks
    const pointLayerURL = "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Trailheads/FeatureServer/0";

    arcgisRest.queryFeatures({
      url: pointLayerURL,
      authentication,
      f: "geojson"
    }).then((response) => {
      Cesium.GeoJsonDataSource.load(response, {
        clampToGround: true,

        // Attribution text retrieved from https://arcgis.com/home/item.html?id=883cedb8c9fe4524b64d47666ed234a7
        credit: "Los Angeles GeoHub"

      }).then((dataSource) => {
        dataSource.name = "trailheads";
        viewer.dataSources.add(dataSource);

        const entities = dataSource.entities.values;
        for (let i = 0; i < entities.length; i++) {
          entities[i].billboard.image = "http://static.arcgis.com/images/Symbols/NPS/npsPictograph_0231b.png";
          entities[i].billboard.scale = 0.4;
        }

      });
    });
Expand

Style trails (lines) by elevation gain

To visualize the elevation gain of trails in the Trails (lines) feature layer, add the layer as a GeoJsonDataSource and the width of each line based on its properties.

Call the arcgisRest.queryFeatures operation to make an authenticated request to the Trails URL. Format the response as GeoJSON and add it to the scene as a GeoJsonDataSource.

Expand
Use dark colors for code blocks
    const lineLayerURL = "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Trails/FeatureServer/0";

    arcgisRest.queryFeatures({
      url: lineLayerURL,
      authentication,
      f: "geojson"
    }).then((response) => {
      Cesium.GeoJsonDataSource.load(response, {
        clampToGround: true,

      }).then((dataSource) => {
        dataSource.name = "trails";
        viewer.dataSources.add(dataSource);

      });
    });
Expand

Add the data attribution for the feature layer source.

Go to the Trails item.
Scroll down to the Acknowledgments section and copy its value.

Paste the copied value to the credit property.

Expand
Use dark colors for code blocks
    const lineLayerURL = "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Trails/FeatureServer/0";

    arcgisRest.queryFeatures({
      url: lineLayerURL,
      authentication,
      f: "geojson"
    }).then((response) => {
      Cesium.GeoJsonDataSource.load(response, {
        clampToGround: true,

        // Attribution text retrieved from https://arcgis.com/home/item.html?id=69e12682738e467eb509d8b54dc73cbd
        credit: "Los Angeles GeoHub"

      }).then((dataSource) => {
        dataSource.name = "trails";
        viewer.dataSources.add(dataSource);

      });
    });
Expand

Iterate through all entities and set the polyline width of each entity based on their ELEV_GAIN property.

Expand
Use dark colors for code blocks
    const lineLayerURL = "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Trails/FeatureServer/0";

    arcgisRest.queryFeatures({
      url: lineLayerURL,
      authentication,
      f: "geojson"
    }).then((response) => {
      Cesium.GeoJsonDataSource.load(response, {
        clampToGround: true,

        // Attribution text retrieved from https://arcgis.com/home/item.html?id=69e12682738e467eb509d8b54dc73cbd
        credit: "Los Angeles GeoHub"

      }).then((dataSource) => {
        dataSource.name = "trails";
        viewer.dataSources.add(dataSource);

        const entities = dataSource.entities.values;
        for (let i = 0; i < entities.length; i++) {
          const trail = entities[i];
          trail.polyline.width = 3 + (4 * trail.properties.ELEV_GAIN._value) / 2300;
          trail.polyline.material = Cesium.Color.fromCssColorString("#FCADF9");
          trail.polyline.zIndex = 2;
        }

      });
    });
Expand

Style parks (polygons) by type

You can create a categorical rendering of parks based on their attribute values. Render the polygon features from the Parks and Open Space feature layer with different colors based on the type of land they represent.

Call the arcgisRest.queryFeatures operation to make an authenticated request to the Parks and Open Space URL. Format the response as GeoJSON and add it to the scene as a GeoJsonDataSource.

Expand
Use dark colors for code blocks
    const polygonLayerURL = "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Parks_and_Open_Space/FeatureServer/0";

    arcgisRest.queryFeatures({
      url: polygonLayerURL,
      authentication,
      f: "geojson"
    }).then((response) => {
      Cesium.GeoJsonDataSource.load(response, {
        clampToGround: true,

      }).then((dataSource) => {
        dataSource.name = "parks";
        viewer.dataSources.add(dataSource);

      });
    });
Expand

Add the data attribution for the feature layer source.

Go to the Parks and Open Space item.
Scroll down to the Acknowledgments section and copy its value.

Paste the copied value to the credit property.

Expand
Use dark colors for code blocks
    const polygonLayerURL = "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Parks_and_Open_Space/FeatureServer/0";

    arcgisRest.queryFeatures({
      url: polygonLayerURL,
      authentication,
      f: "geojson"
    }).then((response) => {
      Cesium.GeoJsonDataSource.load(response, {
        clampToGround: true,

        // Attribution text retrieved from https://arcgis.com/home/item.html?id=f2ea5d874dad427294641d2d45097c0e
        credit: "Los Angeles GeoHub"

      }).then((dataSource) => {
        dataSource.name = "parks";
        viewer.dataSources.add(dataSource);

      });
    });
Expand

The TYPE attribute of the layer contains four different types of parks and open spaces. Define a unique color for each category.

Expand
Use dark colors for code blocks
    const polygonLayerURL = "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Parks_and_Open_Space/FeatureServer/0";

    arcgisRest.queryFeatures({
      url: polygonLayerURL,
      authentication,
      f: "geojson"
    }).then((response) => {
      Cesium.GeoJsonDataSource.load(response, {
        clampToGround: true,

        // Attribution text retrieved from https://arcgis.com/home/item.html?id=f2ea5d874dad427294641d2d45097c0e
        credit: "Los Angeles GeoHub"

      }).then((dataSource) => {
        dataSource.name = "parks";
        viewer.dataSources.add(dataSource);

        const parkColors = {
          "Natural Areas": "#9E559C",
          "Regional Open Space": "#A7C636",
          "Local Park": "#149ECE",
          "Regional Recreation Park": "#ED5151"
        };

      });
    });
Expand

Iterate through all entities and set the polygon material of each entity based on the TYPE of park.

Expand
Use dark colors for code blocks
    const polygonLayerURL = "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Parks_and_Open_Space/FeatureServer/0";

    arcgisRest.queryFeatures({
      url: polygonLayerURL,
      authentication,
      f: "geojson"
    }).then((response) => {
      Cesium.GeoJsonDataSource.load(response, {
        clampToGround: true,

        // Attribution text retrieved from https://arcgis.com/home/item.html?id=f2ea5d874dad427294641d2d45097c0e
        credit: "Los Angeles GeoHub"

      }).then((dataSource) => {
        dataSource.name = "parks";
        viewer.dataSources.add(dataSource);

        const entities = dataSource.entities.values;
        for (let i = 0; i < entities.length; i++) {
          const park = entities[i];

          if (park.polygon == null) {
            continue;
          }

          const color = Cesium.Color.fromCssColorString(parkColors[park.properties.TYPE._value]);
          color.alpha = 0.7;
          park.polygon.material = color;
          park.polygon.zIndex = 1;
          park.polygon.outline = false;
        }

      });
    });
Expand

Run the app

Run the app.

Your map should display the trailheads, trails, and open spaces in the Santa Monica Mountains:

Each trailhead should be represented with a hiker icon.
Each trail should have a custom width based on its total elevation gain.
Each park should be assigned a color based on its type.

What's next?

Learn how to use additional location services in these tutorials:

Display a pop-up (Feature)

Display feature attributes in a popup.

Search for an address

Find an address or place using a search box.

Find a route and directions

Find a route and directions from point A to point B.