import * as query from "@arcgis/core/rest/query.js";
const query = await $arcgis.import("@arcgis/core/rest/query.js");
@arcgis/core/rest/query
Executes different types of query operations on a layer. The most common
method used is executeQueryJSON(), which executes the query for JSON results as defined in the
Query object that is passed as a parameter to the function.
executeQueryJSON()
returns a Promise that resolves to a
FeatureSet, which contains the features in the layer
that satisfy the Query.
You can also obtain the number of features that satisfy the query, the extent of features, related features or records associated with a feature, attachments for features or the featureIds of features.
For example, when working with a feature layer of world cities, to obtain a FeatureSet of cities with a population greater than one million people, use the code below.
- See also
// query featureLayer for cities with a population greater than one million people
const query = await $arcgis.import("@arcgis/core/rest/query");
// url to the layer of interest to query
const url = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/SampleWorldCities/MapServer/0";
const { features } = await query.executeQueryJSON(url, {
where: "POP > 1000000"
});
Method Overview
Name | Return Type | Summary | Object |
---|---|---|---|
Promise<Object> | Query information about attachments associated with features from a feature layer specified in the url parameter. | query | |
Promise<Number> | Gets a count of the number of features that satisfy the input query. | query | |
Promise<Object> | Gets the extent of the features that satisfy the input query. | query | |
Executes a Query against the layer specified in the url parameter. | query | ||
Promise<Number> | Executes a TopFeaturesQuery against a feature service and returns the count of features or records that satisfy the query. | query | |
Promise<Object> | Executes a TopFeaturesQuery against a feature service and returns the Extent of features that satisfy the query. | query | |
Executes a TopFeaturesQuery against a feature service and returns an array of Object IDs of features that satisfy the query. | query | ||
Promise<FeatureSet> | Executes a Query against the layer specified in the url parameter. | query | |
Promise<FeatureSet> | Executes a Query against the layer specified in the url parameter. | query | |
Promise<Object> | Executes a RelationshipQuery against the layer or table specified in the url parameter. | query | |
Promise<FeatureSet> | Executes a TopFeaturesQuery against a feature service and returns a FeatureSet once the promise resolves. | query |
Method Details
-
executeAttachmentQuery
executeAttachmentQuery(url, attachmentQuery, requestOptions){Promise<Object>}
-
Query information about attachments associated with features from a feature layer specified in the url parameter. It will return an error if the layer's capabilities.data.supportsAttachment is set to false.
Parametersurl StringURL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).
Autocasts from ObjectSpecifies the attachment parameters for query.
requestOptions RequestOptionsoptionalAdditional options to be used for the data request.
ReturnsType Description Promise<Object> When resolved, returns an object containing AttachmentInfos grouped by the source feature objectIds.
-
executeForCount
executeForCount(url, query, requestOptions){Promise<Number>}
-
Gets a count of the number of features that satisfy the input query.
Parametersurl StringURL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).
Autocasts from ObjectSpecifies the attributes and spatial filter of the query.
requestOptions RequestOptionsoptionalAdditional options to be used for the data request.
ReturnsType Description Promise<Number> When resolved, the result is the number of features that satisfy the input query. Exampleconst query = await $arcgis.import("@arcgis/core/rest/query"); // url to the layer of interest to query const url = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer/3"; const count = await query.executeForCount(url, { where: "POP07_SQMI > 100" });
-
executeForExtent
executeForExtent(url, query, requestOptions){Promise<Object>}
-
Gets the extent of the features that satisfy the input query. The count of features that satisfy the input query is returned upon resolution as well.
Parametersurl StringURL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).
Autocasts from ObjectSpecifies the attributes and spatial filter of the query.
requestOptions RequestOptionsoptionalAdditional options to be used for the data request.
ReturnsType Description Promise<Object> When resolved, returns the extent and count of the features that satisfy the input query. See the object specification table below for details. Property Type Description count number The number of features that satisfy the input query. extent Extent | null The extent of the features that satisfy the query.
-
Executes a Query against the layer specified in the url parameter. The result is an array of the object IDs of features that satisfy the input query. There is no limit to the number of object IDs returned in the ID array response.
Parametersurl StringURL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).
Autocasts from ObjectSpecifies the attributes and spatial filter of the query.
requestOptions RequestOptionsoptionalAdditional options to be used for the data request.
layerMetadata ObjectoptionalAdditional query options.
Specificationoptional The uniqueIdFields of the FeatureLayer. Specify this parameter, if the FeatureLayer uses non-numeric unique IDs.
ReturnsExampleconst query = await $arcgis.import("@arcgis/core/rest/query"); // url to the layer of interest to query const url = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer/3"; const ids = await query.executeForIds(url, { where: "SUB_REGION = 'Pacific'" }); console.log(ids); // an array of object IDs
-
executeForTopCount
executeForTopCount(url, topFeaturesQuery, requestOptions){Promise<Number>}
Since: ArcGIS Maps SDK for JavaScript 4.25query since 4.19, executeForTopCount added at 4.25. -
Executes a TopFeaturesQuery against a feature service and returns the count of features or records that satisfy the query.
Known Limitations
- Currently, the
executeForTopCount
is only supported with server-side FeatureLayers.
Parametersurl StringURL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).
topFeaturesQuery TopFeaturesQuerySpecifies the attributes, spatial, temporal, and top filter of the query. The topFilter parameter must be set.
requestOptions RequestOptionsoptionalAdditional options to be used for the data request.
ReturnsType Description Promise<Number> When resolved, returns the number of features satisfying the query. Example// set the query to return a count // of features that has most sales grouped by regions. // top query will run against all features available in the service const query = await $arcgis.import("@arcgis/core/rest/query"); const count = await query.executeForTopCount(url, { // autocast to TopFeaturesQuery where: "mag >= 6", topFilter: { // autocast to TopFilter topCount: 1, groupByFields: ["Region"], orderByFields: ["Sales DESC"], }, });
- Currently, the
-
executeForTopExtents
executeForTopExtents(url, topFeaturesQuery, requestOptions){Promise<Object>}
Since: ArcGIS Maps SDK for JavaScript 4.25query since 4.19, executeForTopExtents added at 4.25. -
Executes a TopFeaturesQuery against a feature service and returns the Extent of features that satisfy the query.
Known Limitations
- Currently, the
executeForTopExtents
is only supported with server-side FeatureLayers.
Parametersurl StringURL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).
topFeaturesQuery TopFeaturesQuerySpecifies the attributes, spatial, temporal, and top filter of the query. The topFilter parameter must be set.
requestOptions RequestOptionsoptionalAdditional options to be used for the data request.
ReturnsType Description Promise<Object> When resolved, returns the extent and count of the features that satisfy the input query. See the object specification table below for details. Property Type Description count Number The number of features that satisfy the query. extent Extent | null The extent of features that satisfy the query. Example// Get the count and extent of the three highest magnitude earthquakes in each region. const query = await $arcgis.import("@arcgis/core/rest/query"); const { count, extent } = await query.executeForTopExtents(url, { // autocast to TopFeaturesQuery where: "mag >= 6", topFilter: { // autocast to TopFilter topCount: 3, groupByFields: ["region"], orderByFields: ["mag DESC"] } });
- Currently, the
-
Since: ArcGIS Maps SDK for JavaScript 4.25query since 4.19, executeForTopIds added at 4.25. -
Executes a TopFeaturesQuery against a feature service and returns an array of Object IDs of features that satisfy the query.
Known Limitations
- Currently, the
executeForTopIds
is only supported with server-side FeatureLayers.
Parametersurl StringURL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).
topFeaturesQuery TopFeaturesQuerySpecifies the attributes, spatial, temporal, and top filter of the query. The topFilter parameter must be set.
requestOptions RequestOptionsoptionalAdditional options to be used for the data request.
ReturnsExample// Get the objectIds top three earthquakes // grouped by regions and ordered by their magnitude levels // top query will only run against earthquakes that have mag >=6. const query = await $arcgis.import("@arcgis/core/rest/query"); const ids = await query.executeForTopIds(url, { // autocast to TopFeaturesQuery where: "mag >= 6", topFilter: { // autocast to TopFilter topCount: 3, groupByFields: ["region"], orderByFields: ["mag DESC"] } });
- Currently, the
-
executeQueryJSON
executeQueryJSON(url, query, requestOptions, layerMetadata){Promise<FeatureSet>}
-
Executes a Query against the layer specified in the url parameter. The result is returned as a FeatureSet containing an array of Graphic features, which can be added to the map. This array will not be populated if no results are found.
Parametersurl StringURL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).
Autocasts from ObjectSpecifies the attributes and spatial filter of the query.
requestOptions RequestOptionsoptionalAdditional options to be used for the data request.
layerMetadata ObjectoptionalAdditional query options.
Specificationoptional The uniqueIdFields of the FeatureLayer. Specify this parameter, if the FeatureLayer uses non-numeric unique IDs.
ReturnsType Description Promise<FeatureSet> When resolved, a FeatureSet containing an array of graphic features is returned. Exampleconst query = await $arcgis.import("@arcgis/core/rest/query"); const url = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer/3"; const { features } = await query.executeQueryJSON(url, { where: "STATE_NAME = 'Washington'", outSpatialReference: { wkid: 4269 }, returnGeometry: true, outFields: ["HOUSEHOLDS"], });
-
executeQueryPBF
executeQueryPBF(url, query, requestOptions, layerMetadata){Promise<FeatureSet>}
-
Executes a Query against the layer specified in the url parameter. The result is returned as a FeatureSet. A FeatureSet contains an array of Graphic features, which can be added to the map. This array will not be populated if no results are found.
Parametersurl StringURL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).
Autocasts from ObjectSpecifies the attributes and spatial filter of the query.
requestOptions RequestOptionsoptionalAdditional options to be used for the data request.
layerMetadata ObjectoptionalAdditional query options.
Specificationoptional The uniqueIdFields of the FeatureLayer. Specify this parameter, if the FeatureLayer uses non-numeric unique IDs.
ReturnsType Description Promise<FeatureSet> When resolved, a FeatureSet containing an array of graphics is returned. Exampleconst query = await $arcgis.import("@arcgis/core/rest/query"); const url = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer/3"; const { features } = await query.executeQueryPBF(url, { where: "STATE_NAME = 'Washington'", outSpatialReference: { wkid: 4269 }, returnGeometry: true, outFields: ["HOUSEHOLDS"], });
-
executeRelationshipQuery
executeRelationshipQuery(url, relationshipQuery, requestOptions){Promise<Object>}
-
Executes a RelationshipQuery against the layer or table specified in the url parameter. If the query is successful, the returned results are FeatureSets grouped by source layer or table objectIds.
Parametersurl StringURL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).
Autocasts from ObjectSpecifies relationship parameters for querying related features or records from a layer or a table.
requestOptions RequestOptionsoptionalAdditional options to be used for the data request.
ReturnsType Description Promise<Object> When resolved, the results are FeatureSets grouped by source layer or table objectIds. Each FeatureSet contains an array of Graphic features including the values of the fields requested by the user. Exampleconst [query, RelationshipQuery] = await $arcgis.import([ "@arcgis/core/rest/query.js", "@arcgis/core/rest/support/RelationshipQuery.js", ]); // url to the layer of interest to query const url = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer/0"; // specify relationship query parameter const queryRelationship = new RelationshipQuery({ outFields: ["*"], relationshipId: relationshipId, objectIds: [11, 22] }); // query related features that meet the query parameters const featureSet = await query.executeRelationshipQuery(url, queryRelationship); console.log("query results", featureSet);
-
executeTopFeaturesQuery
executeTopFeaturesQuery(url, topFeaturesQuery, outSpatialReference, requestOptions){Promise<FeatureSet>}
Since: ArcGIS Maps SDK for JavaScript 4.25query since 4.19, executeTopFeaturesQuery added at 4.25. -
Executes a TopFeaturesQuery against a feature service and returns a FeatureSet once the promise resolves. The FeatureSet contains an array of top features grouped and ordered by specified fields. For example, you can call this method to query top three counties grouped by state names while ordering them based on their populations in a descending order.
Known Limitations
- Currently, the
executeTopFeaturesQuery
is only supported with server-side FeatureLayers.
Parametersurl StringURL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).
topFeaturesQuery TopFeaturesQuerySpecifies the attributes, spatial, temporal, and top filter of the query. The topFilter parameter must be set.
outSpatialReference SpatialReferenceThe desired output spatial reference.
requestOptions RequestOptionsoptionalAdditional options to be used for the data request.
ReturnsType Description Promise<FeatureSet> When resolved, returns a FeatureSet containing an array of features that are grouped and ordered specified fields. Example// Query the most visited national parks in each state // and order them by the most visited // query will run against all features available in the service const query = await $arcgis.import("@arcgis/core/rest/query"); const url = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer/3"; const { features } = await query.executeTopFeaturesQuery(url, { // autocast to TopFeaturesQuery outFields: ["State, TOTAL, Park"], topFilter: { // autocast to TopFilter topCount: 1, groupByFields: ["State"], orderByFields: ["TOTAL DESC"] }, });
- Currently, the