Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: QueryTask
[ AMD Module Require | Legacy Module Require ]
require(["esri/tasks/QueryTask"], function(QueryTask) { /* code goes here */ });
Description
(Added at v1.0)
Executes a query operation on a layer resource of a map service exposed by the ArcGIS Server REST API.Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new QueryTask(url, options?) | Creates a new QueryTask object used to execute a query on the layer resource identified by the url. |
Properties
| Name | Type | Summary |
|---|---|---|
| gdbVersion | String | The geodatabase version to display. |
| source | LayerSource | The dynamic layer or table source. |
| url | String | URL to the ArcGIS Server REST resource that represents a map service layer. |
Methods
| Name | Return type | Summary |
|---|---|---|
| execute(parameters, callback?, errback?) | Deferred | Executes a Query against an ArcGIS Server map layer. |
| executeForCount(query, callback?, errback?) | Deferred | Get a count of the number of features that satisfy the input query. |
| executeForExtent(query, callback?, errback?) | Deferred | Get the extent of the features that satisfy the input query. |
| executeForIds(parameters, callback?, errback?) | Deferred | Executes a Query against an ArcGIS Server map layer. |
| executeRelationshipQuery(parameters, callback?, errback?) | Deferred | Executes a RelationshipQuery against an ArcGIS Server map layer (or table). |
Events
[ On Style Events | Connect Style Event ]
All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
Events
| Name | Event Object | Summary |
|---|---|---|
| complete | {
featureSet: < | Fires when the query operation is complete. |
| error | {
error: < | Fires when an error occurs when executing the task. |
| execute-for-count-complete | {
count: < | Fires when the query for the count is complete. |
| execute-for-extent-complete | {
count: < | Fires when the query for the extent is complete. |
| execute-for-ids-complete | {
objectIds: < | Fires when the query on IDs is complete. |
| execute-relationship-query-complete | {
featureSets: < | Fires when the executeRelationshipQuery is complete. |
Constructor Details
Creates a new QueryTask object used to execute a query on the layer resource identified by the url.
Parameters:
< |
Required | URL to the ArcGIS Server REST resource that represents a layer in a service. An example is https://www.example.com/argis/rest/services/Portland/Portland_ESRI_LandBase_AGO/MapServer/1. |
< |
Optional | Optional parameters. See options list. |
options properties: < |
Optional | The geodatabase version to display. (As of v2.7). Requires ArcGIS Server service 10.1 or greater |
< |
Optional | The dynamic layer or table source. The url should end with /dynamicLayer. |
Sample:
require([
"esri/tasks/QueryTask", ...
], function(QueryTask, ... ) {
var queryTask = new QueryTask("https://www.example.com/argis/rest/services/Specialty/ESRI_StatesCitiesRivers_USA/MapServer/0");
...
});
Property Details
<String
StringThe geodatabase version to display. (As of v2.7). Requires ArcGIS Server service 10.1 or greater (Added at v2.7)
<LayerSource
LayerSourceThe dynamic layer or table source. The url should end with
/dynamicLayer.<String
StringURL to the ArcGIS Server REST resource that represents a map service layer. To obtain the URL, use Services Directory.
Method Details
Executes a Query against an ArcGIS Server map layer. The result is returned as a FeatureSet. If the query is successful, the user-specified callback function is invoked with the result. A FeatureSet contains an array of Graphic features, which can be added to the map using Map.graphics.add(). This array will not be populated if no results are found.
Return type:
DeferredParameters:
< |
Required | Specifies the attributes and spatial filter of the query. |
< |
Optional | The function to call when the method has completed. The arguments in the function are the same as the onComplete event. |
< |
Optional | An error object is returned if an error occurs on the Server during task execution. (As of v1.3) |
Sample:
require([
"esri/tasks/query", "esri/tasks/QueryTask", ...
], function(Query, QueryTask, ... ) {
var query = new Query();
var queryTask = new QueryTask( ... );
query.where = "STATE_NAME = 'Washington'";
query.outSpatialReference = {wkid:102100};
query.returnGeometry = true;
query.outFields = ["CITY_NAME"];
queryTask.execute(query, addPointsToMap);
...
});
See also: on("complete"), on("error")
Get a count of the number of features that satisfy the input query. Valid only for layers published using ArcGIS Server 10 SP1 or greater. Layers published with earlier versions of ArcGIS Server return an error to the error callback. (Added at v2.1)
Return type:
DeferredParameters:
< |
Required | Specify the input query object. |
< |
Optional | The function to call when the method has completed. The arguments in the function are the same as the execute-for-count-complete event. |
< |
Optional | An error object is returned if an error occurs on the Server during task execution. |
Sample:
require([
"esri/tasks/query", "esri/tasks/QueryTask", "dojo/dom"...
], function(Query, QueryTask, dom, ... ) {
var query = new Query();
var queryTask = new QueryTask( ... );
query.where = "POP90_SQMI < 100";
queryTask.executeForCount(query,function(count){
dom.byId("info").innerHTML = count + " features matched the input query";
},function(error){
console.log(error);
});
...
});Get the extent of the features that satisfy the input query. The count of features that satisfy the input query is returned as well. Valid only for hosted features services on arcgis.com and for ArcGIS Server 10.3.1 and later. (Added at v3.9)
Return type:
DeferredParameters:
< |
Required | Specify the input query object. |
< |
Optional | The function to call when the method has completed. The arguments in the function are the same as the execute-for-extent-complete event. |
< |
Optional | An error object is returned if an error occurs on the Server during task execution. |
Executes a Query against an ArcGIS Server map layer. The result is an array of object IDs for features that satisfy the input query. There is no limit to the number of object IDs returned in the ID array response. (Added at v2.0)
Return type:
DeferredParameters:
< |
Required | Specifies the attributes and spatial filter of the query. |
< |
Optional | The function to call when the method has completed. The arguments in the function are the same as the onExecuteForIdsComplete event. |
< |
Optional | An error object is returned if an error occurs on the Server during task execution. |
Sample:
require([
"esri/tasks/query", "esri/tasks/QueryTask", ...
], function(Query, QueryTask, ... ) {
var query = new Query();
var queryTask = new QueryTask( ... );
query.where = "region = 'Southern California'";
queryTask.executeForIds(query,function(results){
console.log(results);
});
...
});
See also: on("error"), on("execute-for-ids-complete")
Executes a RelationshipQuery against an ArcGIS Server map layer (or table). The result is returned as a FeatureSet. If the query is successful, the user-specified callback function is invoked with the result. The result of this operation are featuresets grouped by source layer (or table) object IDs. Each featureset contains an array of Graphic features including the values for the fields requested by the user. This array will not be populated if no results are found. (Added at v2.0)
Return type:
DeferredParameters:
< |
Required | Specifies the attributes and spatial filter of the query. |
< |
Optional | The function to call when the method has completed. The arguments in the function are the same as the onExecuteRelationshipQueryComplete event. |
< |
Optional | An error object is returned if an error occurs on the Server during task execution. |
Event Details
[ On Style Events | Connect Style Event ]
Fires when the query operation is complete. Should be used in favor of onComplete. (Added at v3.5)
Event Object Properties:
< |
Fires when the query operation is complete. |
See also: execute()
Fires when an error occurs when executing the task. (Added at v3.6)
Event Object Properties:
< |
ArcGIS Server error message returned in a JavaScript error object. |
Fires when the query for the count is complete. This event is only available for layers published using ArcGIS Server 10 SP1 or later. Should be used in favor of onExecuteForCountComplete. (Added at v3.5)
Event Object Properties:
< |
Fires when the query for the count is complete. This event is only available for layers published using ArcGIS Server 10 SP1 or later. |
Fires when the query for the extent is complete. Valid only for hosted features services on arcgis.com and for ArcGIS Server 10.3.1 and later. (Added at v3.9)
Fires when the query on IDs is complete. Should be used in favor of onExecuteForIdsComplete. (Added at v3.5)
Event Object Properties:
< |
Fires when the query on IDs is complete. |
See also: executeForIds()
Fires when the executeRelationshipQuery is complete. Should be used in favor of onExecuteRelationshipQueryComplete. (Added at v3.5)
Event Object Properties:
< |
Fires when the executeRelationshipQuery is complete. |
See also: executeRelationshipQuery()