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: QueryTaskLocationProvider
[ AMD Module Require | Legacy Module Require ]
Description
(Added at v3.12)
(Currently in beta)
The QueryTaskLocationProvider performs a query against a ArcGIS Feature service or Map service layer based on common fields that are present in both the data and the ArcGIS layer.Samples
Search for samples that use this class.Class hierarchy
esri/tasks/locationproviders.LocationProviderBase |_esri/tasks/locationproviders.LocationProviderRemoteBase |_esri/tasks/locationproviders.QueryTaskLocationProvider
Constructors
| Name | Summary |
|---|---|
| new esri.tasks.locationproviders.QueryTaskLocationProvider(options?) | Creates a new instance of the QueryTaskLocationProvider object. |
Properties
| Name | Type | Summary |
|---|---|---|
| geometryType | String | The geometry type of the returned features. |
| loaded | Boolean | Returns true when the load event has been fired. |
| queryParameters | Object | A query parameter object that will be used to query the ArcGIS layer. |
| queryTask | QueryTask | An instance of a QueryTask. |
| unicode | Boolean | Set to true when querying a field that contains unicode characters. |
| whereFields | Object | A mapping of the fields in the data and the ArcGIS layer to use to perform a join. |
Methods
| Name | Return type | Summary |
|---|---|---|
| locate(features, options?) | Deferred | Assigns geometries to the array of Graphic objects. |
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 |
|---|---|---|
| error | {
error: < | Fires when an error occurs during locate. |
| load | Fires after the provider has loaded. | |
| locate-complete | {
failed: < | Fires when the locate has completed. |
| locate-progress | {
features: < | Fires when the locate() method is in progress. |
Constructor Details
Creates a new instance of the QueryTaskLocationProvider object.
Parameters:
< |
Optional | Define the properties to use when creating the class. See options descriptions for further information. |
options properties: < |
Required | Object containing properties that will be used to query the ArcGIS layer. See the queryParameters table for object details. |
< |
Required | An instance of a QueryTask. |
< |
Required | Set to true when querying a field that contains unicode characters. |
< |
Required | A mapping of the fields in the data and the ArcGIS layer to use to perform a join. |
Property Details
<String
StringThe geometry type of the returned features.
Known values:
"esriGeometryPoint" | "esriGeometryPolygon" | "esriGeometryPolyline"<Object
ObjectA query parameter object that will be used to query the ArcGIS layer. See
queryParameters table below for object details.Object Specifications:
<
queryParameters>< |
Required | The geometry to apply to the spatial filter. |
< |
Required | The maximum allowable offset used for generalizing geometries returned by the query operation. |
< |
Required | Attribute fields to include in the result. |
< |
Required | If true, each feature in the resulting FeatureSet includes the geometry. |
< |
Required | A where clause for the query. |
<QueryTask
QueryTaskAn instance of a QueryTask.
<Boolean
BooleanSet to true when querying a field that contains unicode characters.
Known values:
true | falseDefault value:
false<Object
ObjectA mapping of the fields in the data and the ArcGIS layer to use to perform a join.
Method Details
Assigns geometries to the array of Graphic objects.
Return type:
DeferredParameters:
< |
Required | An array of Graphic objects. |
< |
Optional | Optional parameters. See the Object Specifications table below for the structure of the options object. |
Object Specifications:
<
options>< |
Required | Spatial reference of the output geometry. Defaults to 4326 when not provided. |
< |
Required | A property to notify whether geometry should be located for Graphic object that already has a geometry. The default value is false. |
Event Details
[ On Style Events | Connect Style Event ]
Fires when an error occurs during locate.
Event Object Properties:
< |
Error message returned in a JavaScript error object. |
Fires when the locate has completed.
Fires when the locate() method is in progress.
Event Object Properties:
< |
A status message. |