Query a feature layer (spatial) | OpenLayers

Learn how to perform a spatial query to a feature service.

Make a spatial query to a feature layer using API key authentication

A feature layer can contain a large number of features stored in ArcGIS. To access a subset of these features, you can execute an SQL or spatial query, either together or individually. The results can contain the attributes, geometry, 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 use the OpenLayers Draw interaction to sketch a feature on the map and ArcGIS REST JS to perform a spatial query against the LA County Parcels hosted feature layer. The layer contains ±2.4 million features. The spatial query returns all of the parcels that intersect the sketched feature. A pop-up is also used to display feature attributes.

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 map tutorial; or,
Option 2: Start from the Display a map 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 API key or OAuth developer credentials so your application can access ArcGIS services.

Update the accessToken variable to use your API key.

Expand
Use dark colors for code blocks
 /* Use for API key authentication */  const accessToken = "YOUR_ACCESS_TOKEN"; 
Expand

In both the index.html and callback.html files, replace YOUR_CLIENT_ID and YOUR_REDIRECT_URL 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!

Add references

This tutorial uses ArcGIS REST JS to access a feature layer, and the ol-popup library to display pop-ups.

In the <head> element, add references to the ArcGIS REST JS and ol-popup libraries.

Expand
Use dark colors for code blocks
 <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/ol@v10.7.0/ol.css">  <script src="https://cdn.jsdelivr.net/npm/ol@v10.7.0/dist/ol.js"></script>  <script src="https://cdn.jsdelivr.net/npm/ol-mapbox-style@13.1.1/dist/olms.js"></script>   <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>   <script src="https://unpkg.com/ol-popup@5.1.1/dist/ol-popup.js"></script>  <link rel="stylesheet" href="https://unpkg.com/ol-popup@5.1.1/src/ol-popup.css"> 
Expand

Add layers

You will need two Vector layers. interactionLayer will display the query polygon while the user is drawing it. Once the query returns, parcelLayers will display the individual property parcels in the default style. Each contains a Vector source that initially contains no features.

In order to be able to draw shapes, you create a Draw Interaction, connected to your interactionLayer. By setting its type to Polygon, it only allows polygon features to be drawn.

Add a map load handler to the olms initialization. Inside, define Vector layers parcelLayer and interactionLayer. Provide a black Stroke and blue Fill style for parcelLayer. Add each to the map with map.addLayer.

Expand
Use dark colors for code blocks
 olms.apply(map, basemapURL).then(function (map) {   const parcelLayer = new ol.layer.Vector({  source: new ol.source.Vector({   }),  style: new ol.style.Style({  stroke: new ol.style.Stroke({  color: "black"  }),  fill: new ol.style.Fill({  color: "hsl(200,80%,50%)"  })  })  });  const interactionLayer = new ol.layer.Vector({  source: new ol.source.Vector()  });   map.addLayer(parcelLayer);  map.addLayer(interactionLayer); 
Expand

Add the data attribution for the feature layer source.

Go to the LA County Parcels item.
Scroll down to the Acknowledgments section and copy its value.

Paste the copied value to the attributions property.

Expand
Use dark colors for code blocks
 olms.apply(map, basemapURL).then(function (map) {   const parcelLayer = new ol.layer.Vector({  source: new ol.source.Vector({   // Attribution text retrieved from https://arcgis.com/home/item.html?id=a6fdf2ee0e454393a53ba32b9838b303  attributions: ["| County of Los Angeles Office of the Assessor"]   }),  style: new ol.style.Style({  stroke: new ol.style.Stroke({  color: "black"  }),  fill: new ol.style.Fill({  color: "hsl(200,80%,50%)"  })  })  });  const interactionLayer = new ol.layer.Vector({  source: new ol.source.Vector()  });   map.addLayer(parcelLayer);  map.addLayer(interactionLayer); 
Expand

Create a Draw interaction, linked to interactionLayer, and with a type of Polygon. Add it to the map with map.addInteraction.

Expand
Use dark colors for code blocks
 map.addLayer(parcelLayer);  map.addLayer(interactionLayer);   const drawInteraction = new ol.interaction.Draw({  source: interactionLayer.getSource(),  type: "Polygon",  stopClick: true // don't fire "click" events (needed later)  });   map.addInteraction(drawInteraction); 
Expand

In the top right, click Run. You can now click to create multiple polygons.

Execute the query

Use the ArcGIS REST JS queryFeatures method to find features in the LA County Parcels feature layer that intersect the sketched feature. When the matching parcels are returned, use an EsriJSON feature format to read the features and add them to the parcel layer's source.

Create a function called executeQuery with a geometry parameter and then call arcgisRest.queryFeatures.

Pass the geometry. Specify JSON as the return type and specify returnGeometry. All of the features within the geometry will be returned.

There are many other spatial relationships that you can specify with spatialRel. For example, you can use esriSpatialRelContains to only return parcels within the sketched polygon. See the ArcGIS services reference for details.

Expand
Use dark colors for code blocks
 map.addInteraction(drawInteraction);   function executeQuery(geometry) {   arcgisRest  .queryFeatures({  url: "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/LA_County_Parcels/FeatureServer/0",  geometry: geometry,  geometryType: "esriGeometryPolygon",  spatialRel: "esriSpatialRelIntersects",  f: "json",  returnGeometry: true  })   } 
Expand

Add a response handler. Inside, use an EsriJSON feature format to set the returned parcels as the parcel layer's source.

Expand
Use dark colors for code blocks
 function executeQuery(geometry) {   arcgisRest  .queryFeatures({  url: "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/LA_County_Parcels/FeatureServer/0",  geometry: geometry,  geometryType: "esriGeometryPolygon",  spatialRel: "esriSpatialRelIntersects",  f: "json",  returnGeometry: true  })   .then((response) => {  const features = new ol.format.EsriJSON().readFeatures(response);  parcelLayer.getSource().addFeatures(features);  });   } 
Expand

Trigger the query

When the user completes a polygon, the drawend event is fired, with an object containing the new polygon as a feature attribute. You can use this feature to call executeQuery.

Use the EsriJSON feature format to convert the query polygon into the ArcGIS geometry format. It is not necessary to reproject the data.

Add a handler for the drawEnd event. Inside, use an EsriJSON feature format to convert the feature into an ArcGIS JSON format. Ensure the map's spatial reference information is included, by setting the featureProjection property. Call executeQuery with this feature's geometry.

Expand
Use dark colors for code blocks
 map.addInteraction(drawInteraction);   drawInteraction.on("drawend", (e) => {  const feature = new ol.format.EsriJSON().writeFeatureObject(e.feature, {  featureProjection: map.getView().getProjection()  });   executeQuery(feature.geometry);   }); 
Expand

At the top right, click Run. When you draw a polygon, a spatial query will run against the feature layer and display all land parcels within the boundary of the feature. Interaction polygons and parcels returned from previous queries remain visible. You will address this next.

Add a pop-up

The parcels returned from the query contain many attributes, such as land value and land use type. You can make the parcels interactive by showing a pop-up when the user clicks on a parcel. You create a Popup to display parcel attributes. It is a type of Overlay so you add it to the map with map.addOverlay.

In order for clicking to trigger a pop-up, and not draw another polygon, you need to enable and disable the draw interaction using setActive. Disable the interaction when the user has drawn a complete polygon. Enable it again when the user clicks somewhere other than a parcel, to reset the map. Clear the parcels and interaction layer at the same time.

Create a Popup and save it to a popup variable. Add it to the map with map.addOverlay.

Expand
Use dark colors for code blocks
 .then((response) => {  const features = new ol.format.EsriJSON().readFeatures(response);  parcelLayer.getSource().addFeatures(features);  });   }   const popup = new Popup();  map.addOverlay(popup); 
Expand

Create a map click event handler. Inside, use map.getFeaturesAtPixel to get the clicked parcel, if any. If there is one, use popup.show to display a pop-up containing the parcel's APN, use type, land value and taxation city.

Expand
Use dark colors for code blocks
 const popup = new Popup();  map.addOverlay(popup);   map.on("click", (event) => {  let parcel = map.getFeaturesAtPixel(event.pixel, {  layerFilter: (l) => l === parcelLayer  })[0];  if (parcel) {  // user clicked on a parcel to see more information about it  const message =  `<b>Parcel ${parcel.get("APN")}</b>` +  `<br>Type: ${parcel.get("UseType")} <br>` +  `Land value: ${parcel.get("Roll_LandValue")} <br>` +  `Tax Rate City: ${parcel.get("TaxRateCity")}`;   popup.show(event.coordinate, message);  drawInteraction.abortDrawing();  } else {   }  }); 
Expand

If the user did not click a parcel, hide the pop-up with popup.hide. Clear each layer by calling clear on its Source. Use setActive to enabledrawInteraction.

Expand
Use dark colors for code blocks
 popup.show(event.coordinate, message);  drawInteraction.abortDrawing();  } else {   // user clicked elsewhere on the map to reset  popup.hide();  parcelLayer.getSource().clear();  interactionLayer.getSource().clear();  drawInteraction.setActive(true); 
Expand

In the drawend event handler, use setActive to disable drawInteraction.

Expand
Use dark colors for code blocks
 drawInteraction.on("drawend", (e) => {  const feature = new ol.format.EsriJSON().writeFeatureObject(e.feature, {  featureProjection: map.getView().getProjection()  });   executeQuery(feature.geometry);   drawInteraction.setActive(false); 
Expand

Run the app

Run the app.

When you click on the map to draw a polygon, a spatial query will run against the feature layer and display all land parcels that intersect the boundary of the feature. You can click on a parcel to see a pop-up with information about the parcel, or click somewhere else to reset the map.