Query a feature layer (spatial) | MapLibre GL JS

Learn how to execute a spatial query.

Make a spatial query using API key authentication

A feature layerA feature layer (client-side) is a data layer that can access and display features from a feature service that has the same type of geometry and attribute 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.

In this tutorial, you use GL Draw to 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 then 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. 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 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 map tutorial; or,
Option 2: Start from the Display a map 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 to follow the steps to get an access token with these 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
- Item access
  - Note: If you are using your own custom data layer for this tutorial, you need to grant the API key credentialsAPI 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 access to the layer item. Learn more in Item access privileges.

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 API key or OAuth developer credentialsDeveloper credentials are a type of item in a portal that contains parameters for authentication. There are two types of developer credentials: API key credentials and OAuth credentials.Learn more so your application can access 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.

Update the accessToken variable to use your API key.

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

Add script references

This tutorial uses three additional libraries. ArcGIS REST JS is used for querying the feature layer. Mapbox GL Draw provides drawing tools, allowing the user to define a point, line, or polygon of interest. Terraformer is used to convert GeoJSONGeoJSON is an open standard for representing geographic information in a JSON file. It is commonly used for sharing data between web services or manipulating vector data in the browser.Learn more features generated by Mapbox GL Draw into ArcGIS JSON geometries, which is required to query the feature layer.

Add <script> tags to reference the libraries.

Expand
Use dark colors for code blocks
  <head>
    <title>MapLibre ArcGIS tutorial: Query a feature layer (spatial)</title>
    <meta charset="utf-8">
    <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no">
    <!-- Load MapLibre GL JS from CDN -->
    <script src="https://unpkg.com/maplibre-gl@5.23.0/dist/maplibre-gl.js"></script>
    <link href="https://unpkg.com/maplibre-gl@5.23.0/dist/maplibre-gl.css" rel="stylesheet">
    <!-- Load MapLibre ArcGIS from CDN -->
    <script src="https://unpkg.com/@esri/maplibre-arcgis@1.1.0/dist/umd/maplibre-arcgis.min.js"></script>

    <link rel="stylesheet" href="https://api.mapbox.com/mapbox-gl-js/plugins/mapbox-gl-draw/v1.4.2/mapbox-gl-draw.css"
    >
    <script src="https://api.mapbox.com/mapbox-gl-js/plugins/mapbox-gl-draw/v1.4.2/mapbox-gl-draw.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/@terraformer/arcgis@2.1.2/dist/t-arcgis.umd.js"></script>

    <style>
    html,
    body,
    #map {
      padding: 0;
      margin: 0;
      height: 100%;
      width: 100%;
      font-family: Arial, Helvetica, sans-serif;
      font-size: 14px;
      color: #323232;
    }


    </style>
  </head>
Expand

Add Mapbox GL Draw

To display the Mapbox GL Draw controls, create a MapboxDraw and call map.addControl. By default, other tools are included, so you need to specify the three required tools: point, line, and polygon.

Create a MapboxDraw and add it to the Map.

Expand
Use dark colors for code blocks
    const map = new maplibregl.Map({
      container: "map", // the id of the div element
      zoom: 12, // starting zoom

      center: [-118.80543, 34.03] // starting location [longitude, latitude]

    });
    const basemapStyle = maplibreArcGIS.BasemapStyle.applyStyle(map, {
      style: "arcgis/outdoor",
      token: accessToken
    });

    const draw = new MapboxDraw({
      displayControlsDefault: false, // Don't add any tools other than those below
      controls: {
        point: true,
        line_string: true,
        polygon: true
      }
    });
    map.addControl(draw, "top-left");
Expand

Edit the MapboxDraw global constants to allow compatibility with MapLibre GL JS.

Expand
Use dark colors for code blocks
    const map = new maplibregl.Map({
      container: "map", // the id of the div element
      zoom: 12, // starting zoom

      center: [-118.80543, 34.03] // starting location [longitude, latitude]

    });
    const basemapStyle = maplibreArcGIS.BasemapStyle.applyStyle(map, {
      style: "arcgis/outdoor",
      token: accessToken
    });

    MapboxDraw.constants.classes.CONTROL_BASE = "maplibregl-ctrl";
    MapboxDraw.constants.classes.CONTROL_PREFIX = "maplibregl-ctrl-";
    MapboxDraw.constants.classes.CONTROL_GROUP = "maplibregl-ctrl-group";

    const draw = new MapboxDraw({
      displayControlsDefault: false, // Don't add any tools other than those below
      controls: {
        point: true,
        line_string: true,
        polygon: true
      }
    });
    map.addControl(draw, "top-left");
Expand

Add query layers

Three layersA layer in Mapbox GL JS is a visual element that displays data from a source.Learn more are required to display the three types of query you can perform: circle, line, and fill. They share a single GeoJSONGeoJSON is an open standard for representing geographic information in a JSON file. It is commonly used for sharing data between web services or manipulating vector data in the browser.Learn more sourceA source in Mapbox GL JS is a file or service that supplies data for a layer displayed in a map.Learn more, which at any time will contain one feature of either Point, LineString or Polygon geometry. Create the source with an empty GeoJSON feature collection.

A line layer can display both line features and the border of polygon features.

The circle layer should be filtered to only display point features. Otherwise, a circle will be shown at each vertex of line and polygon features. You can use a filter and the ['geometry-type'] expression. See the MapLibre Style Specification for more details.

Similarly, the fill layer should be filtered to only display polygon features. Otherwise, line features will be treated as polygons and filled inappropriately.

Create an addQueryLayers function. Inside, add a GeoJSON source and circle, line, and fill layers.

Expand
Use dark colors for code blocks
    function addQueryLayers() {
      map.addSource("query", {
        type: "geojson",
        data: {
          type: "FeatureCollection",
          features: []
        }
      });
      map.addLayer({
        id: "query-line",
        type: "line",
        source: "query",
        paint: {
          "line-color": "hsl(140, 0%, 30%)",
          "line-width": 2,
          "line-dasharray": [2, 2]
        }
      });
      map.addLayer({
        id: "query-fill",
        type: "fill",
        source: "query",
        paint: {
          "fill-color": "hsl(140, 0%, 50%)",
          "fill-opacity": 0.2
        },
        filter: ["==", ["geometry-type"], "Polygon"]
      });

      map.addLayer({
        id: "query-circle",
        type: "circle",
        source: "query",
        paint: {
          "circle-color": "hsl(140, 0%, 30%)"
        },
        filter: ["==", ["geometry-type"], "Point"]
      });
    }
Expand

Add parcel layers

Parcels returned by the query are simple polygons. You can display them with a GeoJSONGeoJSON is an open standard for representing geographic information in a JSON file. It is commonly used for sharing data between web services or manipulating vector data in the browser.Learn more source and a fill layerA layer in Mapbox GL JS is a visual element that displays data from a source.Learn more.

Create an addParcelLayers function. Inside, add a GeoJSON source and a fill layer.

Expand
Use dark colors for code blocks
      map.addLayer({
        id: "query-circle",
        type: "circle",
        source: "query",
        paint: {
          "circle-color": "hsl(140, 0%, 30%)"
        },
        filter: ["==", ["geometry-type"], "Point"]
      });
    }

    function addParcelLayers() {
      map.addSource("parcels", {
        type: "geojson",
        data: {
          type: "FeatureCollection",
          features: []
        },

      });
      map.addLayer({
        id: "parcels-fill",
        source: "parcels",
        type: "fill",

        paint: {
          "fill-color": "hsl(200, 80%, 50%)",
          "fill-opacity": 0.5,
          "fill-outline-color": "white"
        }
      });
    }
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 attribution property.

Expand
Use dark colors for code blocks
    function addParcelLayers() {
      map.addSource("parcels", {
        type: "geojson",
        data: {
          type: "FeatureCollection",
          features: []
        },

        // Attribution text retrieved from https://arcgis.com/home/item.html?id=a6fdf2ee0e454393a53ba32b9838b303
        attribution: "LA County Parcels"

      });
      map.addLayer({
        id: "parcels-fill",
        source: "parcels",
        type: "fill",

        paint: {
          "fill-color": "hsl(200, 80%, 50%)",
          "fill-opacity": 0.5,
          "fill-outline-color": "white"
        }
      });
    }
Expand

Add a load handler

To add layers to the map, use the load event to ensure the map is fully loaded.

Add an event handler for the load event. Inside, call addQueryLayers and addParcelLayers;

Expand
Use dark colors for code blocks
        paint: {
          "fill-color": "hsl(200, 80%, 50%)",
          "fill-opacity": 0.5,
          "fill-outline-color": "white"
        }
      });
    }

    map.on("load", () => {

      addParcelLayers();

      addQueryLayers();
    });
Expand

Get the draw feature

Mapbox GL Draw emits a draw.create event when you have finished drawing a feature. You can listen to this event to respond to the newly created feature.

By default, Mapbox GL Draw keeps all previously drawn features visible in its own layerA layer in Mapbox GL JS is a visual element that displays data from a source.Learn more. To prevent this, use deleteAll after copying the feature.

Add an event handler for draw.create. Inside, store the feature in the query layer, then delete all features from Mapbox GL Draw.

Expand
Use dark colors for code blocks
    map.on("load", () => {

      addParcelLayers();

      addQueryLayers();
    });

    map.on("draw.create", (e) => {
      const feature = e.features[0];
      map.getSource("query").setData(feature);
      draw.deleteAll();

    });
Expand

Click Run at the top right to test your code. You should be able to sketch a point, line or polygon feature, and see it turn into a green feature when complete.

Execute the query

Use the ArcGIS REST JS queryFeatures method to find features in the LA County Parcels feature layerA feature layer (client-side) is a data layer that can access and display features from a feature service that has the same type of geometry and attribute fields.Learn more that match the selected where clause. Use Terraformer.geojsonToArcGIS to convert the GeoJSONGeoJSON is an open standard for representing geographic information in a JSON file. It is commonly used for sharing data between web services or manipulating vector data in the browser.Learn more from Mapbox GL Draw into the ArcGIS geometry format.

When the matching parcels are returned, call setData on the parcels sourceA source in Mapbox GL JS is a file or service that supplies data for a layer displayed in a map.Learn more to display them.

Create a function that calls arcgisRest.queryFeatures. Specify GeoJSONGeoJSON is an open standard for representing geographic information in a JSON file. It is commonly used for sharing data between web services or manipulating vector data in the browser.Learn more as the return type, requesting returnGeometry and specific outFields. All of the 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 within the 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 will be returned with attributeAttributes 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 information set by the outFields property.

Expand
Use dark colors for code blocks
    map.on("draw.create", (e) => {
      const feature = e.features[0];
      map.getSource("query").setData(feature);
      draw.deleteAll();

    });

    function executeQuery(geometry, geometryType) {

      arcgisRest
        .queryFeatures({
          url: "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/LA_County_Parcels/FeatureServer/0",
          geometry: geometry,
          geometryType: geometryType,
          spatialRel: "esriSpatialRelIntersects",
          f: "geojson",
          returnGeometry: true,
          outFields: ["APN", "UseType", "TaxRateCity", " Roll_LandValue"]
        })

    }
Expand

Add a response handler. Inside, set the returned parcels as the data for the parcels source.

Expand
Use dark colors for code blocks
      arcgisRest
        .queryFeatures({
          url: "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/LA_County_Parcels/FeatureServer/0",
          geometry: geometry,
          geometryType: geometryType,
          spatialRel: "esriSpatialRelIntersects",
          f: "geojson",
          returnGeometry: true,
          outFields: ["APN", "UseType", "TaxRateCity", " Roll_LandValue"]
        })

        .then((response) => {
          map.getSource("parcels").setData(response);
        });

    }
Expand

In your MapboxDraw event handler, call executeQuery. Use Terraformer.geojsonToArcGIS to convert geometry into an ArcGIS JSON format.

Expand
Use dark colors for code blocks
    map.on("draw.create", (e) => {
      const feature = e.features[0];
      map.getSource("query").setData(feature);
      draw.deleteAll();

      const geometry = Terraformer.geojsonToArcGIS(feature.geometry);
      let geometryType = "esriGeometry" + feature.geometry.type;
      if (feature.geometry.type === "LineString") {
        geometryType = "esriGeometryPolyline";
      }
      executeQuery(geometry, geometryType);

    });
Expand

At the top right, click Run. When you create a feature using the toolbox, a spatial query will run against the feature layerA feature layer (client-side) is a data layer that can access and display features from a feature service that has the same type of geometry and attribute fields.Learn more and display all land parcels within the boundary of the feature.

Add a pop-up

You can add a pop-up to view attributes of a parcel when you click on it.

Add a click event handler to the parcels-fill layer. Inside, construct the pop-up content from the attributes of the clicked parcel.

Expand
Use dark colors for code blocks
        .then((response) => {
          map.getSource("parcels").setData(response);
        });

    }

    map.on("click", "parcels-fill", (e) => {
      const p = e.features[0].properties;
      const message =
        `<b>Parcel ${p.APN}</b>` +
        `Type: ${p.UseType} <br>` +
        `Land value: $${p.Roll_LandValue.toLocaleString()} <br>` +
        `Tax Rate City: ${p.TaxRateCity}`;

    });
Expand

Create a Popup and add it to the map using Popup.addTo.

Expand
Use dark colors for code blocks
    map.on("click", "parcels-fill", (e) => {
      const p = e.features[0].properties;
      const message =
        `<b>Parcel ${p.APN}</b>` +
        `Type: ${p.UseType} <br>` +
        `Land value: $${p.Roll_LandValue.toLocaleString()} <br>` +
        `Tax Rate City: ${p.TaxRateCity}`;

      new maplibregl.Popup().setHTML(message).setLngLat(e.lngLat).addTo(map);

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