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
Properties
Methods
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.
Constructor Details
Creates a new instance of the QueryTaskLocationProvider object.
Parameters:
<Object > options |
Optional |
Define the properties to use when creating the class. See options descriptions for further information. |
options
properties:
<Object > queryParameters |
Required |
Object containing properties that will be used to query the ArcGIS layer. See the queryParameters table for object details. |
<QueryTask > queryTask |
Required |
An instance of a QueryTask. |
<Boolean > unicode |
Required |
Set to true when querying a field that contains unicode characters. |
<Object > whereFields |
Required |
A mapping of the fields in the data and the ArcGIS layer to use to perform a join. |
Property Details
The geometry type of the returned features.
Known values: "esriGeometryPoint" | "esriGeometryPolygon" | "esriGeometryPolyline"
Returns true when the load event has been fired.
Known values: true | false
A query parameter object that will be used to query the ArcGIS layer. See queryParameters
table below for object details.
Object Specifications: <queryParameters
>
<Geometry > geometry |
Required |
The geometry to apply to the spatial filter. |
<Number > maxAllowableOffset |
Required |
The maximum allowable offset used for generalizing geometries returned by the query operation. |
<String[] > outFields |
Required |
Attribute fields to include in the result. |
<Boolean > returnGeometry |
Required |
If true , each feature in the resulting FeatureSet includes the geometry. |
<String > where |
Required |
A where clause for the query. |
An instance of a QueryTask.
Set to true when querying a field that contains unicode characters.
Known values: true | false
Default value: false
A 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.
Parameters:
<Graphic[] > features |
Required |
An array of Graphic objects. |
<Object > options |
Optional |
Optional parameters. See the Object Specifications table below for the structure of the options object. |
Object Specifications: <options
>
<SpatialReference > outSpatialReference |
Required |
Spatial reference of the output geometry. Defaults to 4326 when not provided. |
<Boolean > useExistingGeometries |
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.
Fires after the provider has loaded. The locate method can be called after this event.
Fires when the locate has completed.
Event Object Properties:
<Graphic[] > failed |
An array of the features that failed to complete successfully. |
<Graphic[] > features |
An array of the completed features. |
Fires when the locate() method is in progress.
Fires when an error occurs during locate.
Fires after the provider has loaded. The locate method can be called after this event.
Fires when the locate has completed.
Event Object Properties:
<Graphic[] > features |
An array of the completed features. |
<Graphic[] > failed |
An array of the features that failed to complete successfully. |
(Need clarification) Fires when the locate is in progress.