Tutorial: Query features (spatial) | CesiumJS

Learn how to execute a spatial query to access polygon featuresA feature is a single record, also known as a row, that represents a real-world entity. It typically contains a geometry (point, multipoint, polyline, or polygon) and attributes but it can also contain just attributes.Learn more from a feature serviceA feature service is a data service that provides access to spatial and non-spatial data in feature layers, feature layer views, and tables.Learn more.

Make a spatial query using API key authentication

A feature layerA feature layer (server-side) is a spatially-enabled table in a feature service. All features in a feature layer share the same geometry type and set of fields.Learn more can contain a large number of featuresA feature is a single record, also known as a row, that represents a real-world entity. It typically contains a geometry (point, multipoint, polyline, or polygon) and attributes but it can also contain just attributes.Learn more stored in ArcGISArcGIS is the brand name for all of the desktop, server, and developer products and technologies offered by Esri.Learn more. To access a subset of these features, you can execute an SQL or spatial query, either together or individually. The results can contain the attributesAttributes are fields and values for a single feature or non-spatial record. They are typically stored in a database or service such as a feature service.Learn more, geometryA geometry is a geometric shape, such as a point, polyline, or polygon, that contains one or more coordinates and a spatial reference.Learn more, or both for each record. SQL and spatial queries are useful when a feature layer is very large and you want to access only a subset of its data.

In this tutorial, you sketch a featureA feature is a single record, also known as a row, that represents a real-world entity. It typically contains a geometry (point, multipoint, polyline, or polygon) and attributes but it can also contain just attributes.Learn more on the map and use ArcGIS REST JS to perform a spatial query against the LA County Parcels hosted feature layerA hosted feature layer is a hosted layer (item) in a portal that is used to manage the properties and settings of a spatially-enabled feature layer in a feature service.Learn more. The layer contains ±2.4 million features. The spatial query returns all of the parcels that intersect the sketched feature.

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 applicationsA public application is an application that allows anonymous access without requiring users to sign in with an ArcGIS account. It supports API key or app authentication.Learn more that access ArcGIS Location ServicesArcGIS Location Services, also referred to as Location Services, are services hosted by Esri that provide geospatial functionality for developing mapping applications. They include the ArcGIS Basemap Styles service, ArcGIS Static Basemap Tiles service, ArcGIS Places service, ArcGIS Geocoding service, ArcGIS Routing service, ArcGIS GeoEnrichment service, and ArcGIS Elevation service. An ArcGIS Location Platform or ArcGIS Online account is required to use the services.Learn more and secure itemsAn item, also known as a content item, is a resource stored in a portal such as a web map, hosted layer, style, script tool, file, or notebook.Learn more.
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 accountAn ArcGIS account is an identity with a user type and set of privileges that can access specific ArcGIS products, tools, APIs, services, and resources. The main account types that can be used for development are an ArcGIS Location Platform account, ArcGIS Online account, and ArcGIS Enterprise account. ArcGIS Location Platform and ArcGIS Online accounts are also associated with a subscription.Learn more 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 credentialAPI key credentials are an item that contains the parameters used to create and manage long-lived access tokens for API key authentication. They are a type of developer credential.Learn more with the correct privileges to get an access token.

Go to the Create an API key tutorial and create an API keyAn API key is a long-lived access token created using API key credentials. They are valid for up to one year and are typically embedded directly into client applications.Learn more with the following privilege(s)Privileges are a set of permissions assigned to ArcGIS accounts, developer credentials, and applications that grant access to secure resources and functionality in ArcGIS.Learn more:
- Privileges
  - Location services > Basemaps

Create a new OAuth credentialOAuth credentials are an item that contains parameters required to implement user authentication or app authentication, including a client_id, client_secret, and redirect URIs. They are a type of developer credential.Learn more to register the application.

Go to the Create OAuth credentials for user authentication tutorial to create an OAuth credential.
Copy the Client ID and Redirect URL from your OAuth credentials item and paste them to a safe location. They will be used in a later step.

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 tokenAn access token is an authorization string that provides access to secure ArcGIS content, data, and services. Its capabilities are determined by the privileges it supports. It is obtained by implementing API key authentication, User authentication, or App authentication.Learn more. Set YOUR_ACCESS_TOKEN with the access token you previously copied from your API key credentialAPI key credentials are an item that contains the parameters used to create and manage long-lived access tokens for API key authentication. They are a type of developer credential.Learn more.
Expand
Use dark colors for code blocks
```
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
    <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 servicesA service, also known as an ArcGIS service, is software that supports an ArcGIS REST API and provides geospatial functionality or data. A service can be hosted by Esri or in ArcGIS Enterprise.Learn more 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 credentialsOAuth credentials are an item that contains parameters required to implement user authentication or app authentication, including a client_id, client_secret, and redirect URIs. They are a type of developer credential.Learn more.

index.html
Use dark colors for code blocksCopy
    /* 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 blocksCopy
    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!

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.

Use dark colors for code blocks
    <script src="https://cesium.com/downloads/cesiumjs/releases/1.140/Build/Cesium/Cesium.js"></script>
    <link href="https://cesium.com/downloads/cesiumjs/releases/1.140/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>

In the <body>, create an arcgisRest.ApiKeyManager using your access token to authenticate requests to the feature serviceA feature service is a data service that provides access to spatial and non-spatial data in feature layers, feature layer views, and tables.Learn more.

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);

Create a drawing mode selector

Create a <select> HTML element to provide a list of spatial operations for drawing features such as points, lines, or polygons.

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

    <select id="mode-select">
      <option value="">Choose a type of feature to draw...</option>
      <option value="Point">Draw point</option>
      <option value="Polyline">Draw line</option>
      <option value="Polygon" selected>Draw polygon</option>
    </select>

Style the <select> element so that it displays properly in your application.

Use dark colors for code blocks
    <script src="https://unpkg.com/@terraformer/arcgis@2.0.7/dist/t-arcgis.umd.js"></script>
    <style>
      html,
      body,
      #cesiumContainer {
        width: 100%;
        height: 100%;
        padding: 0px;
        margin: 0px;
      }

      #mode-select {
        position: absolute;
        top: 8px;
        left: 8px;
        padding: 4px 8px;
        font-size: 16px;
        border-radius: 0;
      }

    </style>

Add a feature layer

Reference the LA County Parcels hosted feature layerA hosted feature layer is a hosted layer (item) in a portal that is used to manage the properties and settings of a spatially-enabled feature layer in a feature service.Learn more in your application to perform a spatial query against. The layer contains ±2.4 million features. The spatial query returns all of the parcels that intersect the sketched feature.

Copy the URL of the LA County Parcels feature layer.

Expand
Use dark colors for code blocks
    const layerName = "LA_County_Parcels";
    const layerURL = "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/" + layerName + "/FeatureServer/0";
Expand

Add the data attributionData attribution is the requirement to display the names of data source providers in all applications when accessing ArcGIS content, layers, or services.Learn more for the feature layer source.

Go to the LA County Parcels itemAn item, also known as a content item, is a resource stored in a portal such as a web map, hosted layer, style, script tool, file, or notebook.Learn more.
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
    // Attribution text retrieved from https://arcgis.com/home/item.html?id=a6fdf2ee0e454393a53ba32b9838b303
    viewer.creditDisplay.addStaticCredit(new Cesium.Credit("County of Los Angeles Office of the Assessor", false));
Expand

Create drawing tools

A spatial query is performed by passing a geometryA geometry is a geometric shape, such as a point, polyline, or polygon, that contains one or more coordinates and a spatial reference.Learn more object to a hosted feature layerA hosted feature layer is a hosted layer (item) in a portal that is used to manage the properties and settings of a spatially-enabled feature layer in a feature service.Learn more. Add tools that allow the user of your app to draw pointA point is a type of geometry containing a single set of x,y coordinates and a spatial reference.Learn more, lineA polyline is a type of geometry containing ordered point coordinates and a spatial reference.Learn more, and polygonA polygon is a type of geometry containing an array of rings and a spatial reference. Each ring contains an array of point coordinates, where the first and last point are the same.Learn more geometries on the map.

Add methods to draw points, lines, and polygons on the map. The methods will be called based on the drawing mode the user selects.

Expand
Use dark colors for code blocks
    if (!viewer.scene.pickPositionSupported) {
      window.alert("This browser does not support pickPosition.");
    }

    viewer.cesiumWidget.screenSpaceEventHandler.removeInputAction(
      Cesium.ScreenSpaceEventType.LEFT_DOUBLE_CLICK
    );
    function createPoint(worldPosition) {
      const point = viewer.entities.add({
        position: worldPosition,
        point: {
          color: Cesium.Color.WHITE,
          pixelSize: 5,
          heightReference: Cesium.HeightReference.CLAMP_TO_GROUND
        }
      });
      return point;
    }
    let drawingMode;
    function drawShape(positionData) {
      let shape;
      if (drawingMode === "Polyline") {
        shape = viewer.entities.add({
          polyline: {
            positions: positionData,
            clampToGround: true,
            width: 3
          }
        });
      } else if (drawingMode === "Polygon") {
        shape = viewer.entities.add({
          polygon: {
            hierarchy: positionData,
            outline: true,
            outlineWidth: 10,
            material: new Cesium.ColorMaterialProperty(
              Cesium.Color.WHITE.withAlpha(0.4)
            )
          }
        });
      }
      return shape;
    }
Expand

Set up event handlers to initiate drawing in the selected mode (point, polyline, or polygon) when the user clicks. Dynamically update the shape based on mouse clicks and movements.

Expand
Use dark colors for code blocks
    let activeShapePoints = [];
    let activeShape;
    let floatingPoint;
    let newShape = true;

    const handler = new Cesium.ScreenSpaceEventHandler(viewer.canvas);
    handler.setInputAction(function (event) {
      if (!drawingMode) return;
      if (newShape) {
        viewer.entities.removeAll();
        newShape = false;
      }

      const earthPosition = viewer.camera.pickEllipsoid(event.position);
      // `earthPosition` will be undefined if our mouse is not over the globe.
      if (Cesium.defined(earthPosition)) {
        // Points
        if (drawingMode === "Point") {
          activeShapePoints.push(earthPosition);
          createPoint(earthPosition);
          performQuery();
        } else {
          if (activeShapePoints.length === 0) {
            floatingPoint = createPoint(earthPosition);
            activeShapePoints.push(earthPosition);
            const dynamicPositions = new Cesium.CallbackProperty(function () {
              if (drawingMode === "Polygon") {
                return new Cesium.PolygonHierarchy(activeShapePoints);
              }
              return activeShapePoints;
            }, false);
            activeShape = drawShape(dynamicPositions);
          }
          activeShapePoints.push(earthPosition);
          createPoint(earthPosition);
        }
      }
    }, Cesium.ScreenSpaceEventType.LEFT_CLICK);

    handler.setInputAction(function (event) {
      if (Cesium.defined(floatingPoint)) {
        const newPosition = viewer.camera.pickEllipsoid(event.endPosition);
        if (Cesium.defined(newPosition)) {
          floatingPoint.position.setValue(newPosition);
          activeShapePoints.pop();
          activeShapePoints.push(newPosition);
        }
      }
    }, Cesium.ScreenSpaceEventType.MOUSE_MOVE);
Expand

Add code to terminate the drawing when the user double clicks.

Expand
Use dark colors for code blocks
    handler.setInputAction(function (event) {
      if (Cesium.defined(floatingPoint)) {
        const newPosition = viewer.camera.pickEllipsoid(event.endPosition);
        if (Cesium.defined(newPosition)) {
          floatingPoint.position.setValue(newPosition);
          activeShapePoints.pop();
          activeShapePoints.push(newPosition);
        }
      }
    }, Cesium.ScreenSpaceEventType.MOUSE_MOVE);

    // Redraw the shape so it's not dynamic and remove the dynamic shape.
    function terminateShape() {
      viewer.entities.remove(floatingPoint);
      viewer.entities.remove(activeShape);
      floatingPoint = undefined;
      activeShape = undefined;
      activeShapePoints = [];
      newShape = true;
    }

    // Event listeners
    handler.setInputAction(function (event) {
      if (drawingMode === "Point" || !drawingMode) return;
      activeShapePoints.pop();

    }, Cesium.ScreenSpaceEventType.LEFT_DOUBLE_CLICK);

    const select = document.getElementById("mode-select");
    select.addEventListener("change", () => {
      terminateShape();
      viewer.entities.removeAll();
      drawingMode = select.value;
    });
Expand

Create a helper function that converts the resulting geometries into ArcGIS format. This will be used to query the feature layerA hosted feature layer is a hosted layer (item) in a portal that is used to manage the properties and settings of a spatially-enabled feature layer in a feature service.Learn more.

Expand
Use dark colors for code blocks
    // Process features
    function getArcGISFeature(points) {
      //convert each point to cartesian latlng
      const degrees = [];
      for (point of points) {
        const cartographic = Cesium.Cartographic.fromCartesian(point);
        degrees.push([Cesium.Math.toDegrees(cartographic.longitude), Cesium.Math.toDegrees(cartographic.latitude)]);
      }
      let coords;
      let type = drawingMode;
      if (drawingMode === "Point") {
        coords = degrees[0];
      } else if (drawingMode === "Polyline") {
        type = "LineString";
        coords = degrees;
      } else {
        coords = [degrees];
      }

      const result = Terraformer.geojsonToArcGIS({
        coordinates: coords,
        type: type
      });

      return result;

    }
Expand

Query the feature layer

Create an executeQuery function that uses arcgisRest.queryFeatures to query the LA County Parcels feature layer with a geometry. Set the spatialRel parameter of the request to esriSpatialRelIntersects to find parcels that intersect the geometry.

Expand
Use dark colors for code blocks
    function executeQuery(geometry) {

      arcgisRest.queryFeatures({
        url: layerURL,
        authentication,
        f: "geojson",

        geometry: geometry,
        geometryType: "esriGeometry" + drawingMode,
        inSR: 4326,
        spatialRel: "esriSpatialRelIntersects",
        returnGeometry: true

      })

    }
Expand

Call executeQuery using the drawn geometry when the user is finished drawing.

Expand
Use dark colors for code blocks
    }

    function performQuery() {
      viewer.dataSources.removeAll();
      const geometry = getArcGISFeature(activeShapePoints);

      executeQuery(geometry);

      drawShape(activeShapePoints);
      terminateShape();
    }

    // Redraw the shape so it's not dynamic and remove the dynamic shape.
    function terminateShape() {
      viewer.entities.remove(floatingPoint);
      viewer.entities.remove(activeShape);
      floatingPoint = undefined;
      activeShape = undefined;
      activeShapePoints = [];
      newShape = true;
    }

    // Event listeners
    handler.setInputAction(function (event) {
      if (drawingMode === "Point" || !drawingMode) return;
      activeShapePoints.pop();

      performQuery();

    }, Cesium.ScreenSpaceEventType.LEFT_DOUBLE_CLICK);
Expand

Load the resulting features onto the map as a Cesium.GeoJsonDataSource.

Expand
Use dark colors for code blocks
    function executeQuery(geometry) {

      arcgisRest.queryFeatures({
        url: layerURL,
        authentication,
        f: "geojson",

        geometry: geometry,
        geometryType: "esriGeometry" + drawingMode,
        inSR: 4326,
        spatialRel: "esriSpatialRelIntersects",
        returnGeometry: true

      })

        .then((response) => {
          Cesium.GeoJsonDataSource.load(response).then((data) => {
            viewer.dataSources.add(data);
          });
        });

    }
Expand

Run the app

Run the app.

You should be able to draw features on the map and perform spatial queries against the feature layer.

What's next?

Learn how to use additional location services in these tutorials:

Map showing a coastal neighborhood highlighted to represent features returned from a SQL query on a feature layer.

Query features (SQL)

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

CesiumJS scene with color-coded regions and symbols representing trailheads, trails, and open spaces.

Style features

Use data-driven styling to apply symbol colors and styles to features.

CesiumJS scene displaying demographic data within a 1-mile radius of the selected location.

Get global data

Query demographic information for locations around the world.