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: StandardGeographyQueryLocationProvider
[ AMD Module Require | Legacy Module Require ]
require(["esri/tasks/locationproviders/StandardGeographyQueryLocationProvider"], function(StandardGeographyQueryLocationProvider) { /* code goes here */ });
Description
(Added at v3.12)
(Currently in beta)
The StandardGeographyQueryLocationProvider class uses the Geoenrichment service to generate geometries by querying the standard geography layers.Samples
Search for samples that use this class.Class hierarchy
esri/tasks/locationproviders/LocationProviderBase |_esri/tasks/locationproviders/LocationProviderRemoteBase |_esri/tasks/locationproviders/StandardGeographyQueryLocationProvider
Constructors
| Name | Summary |
|---|---|
| new StandardGeographyQueryLocationProvider(options) | Creates a new instance of the StandardGeographyQueryLocationProvider object. |
Properties
| Name | Type | Summary |
|---|---|---|
| geographyQueryTemplate | String | A template to be used to build the query for Standard Geography query. |
| geometryType | String | The geometry type of the returned features. |
| loaded | Boolean | Returns true when the load event has been fired. |
| queryParameters | Object | An object that specifies the parameters to use in the Standard Geography query. |
| standardGeographyQueryTask | StandardGeographyQueryTask | An instance of the StandardGeographyQueryTask class. |
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 StandardGeographyQueryLocationProvider object.
Parameters:
< |
Required | Define the properties to use when creating the class. See options descriptions for further information. |
options properties: < |
Required | A template to be used to build the query for Standard Geography query. |
< |
Optional | An object that specifies the parameters to use in the Standard Geography query. Any of the properties in the GeographyQuery properties table can be used in this object. |
< |
Required | An instance of the StandardGeographyQuery class. |
Sample:
require([
"esri/tasks/locationproviders/StandardGeographyQueryLocationProvider",
"esri/tasks/geoenrichment/StandardGeographyQuery",...
], function(StandardGeographyQueryLocationProvider, StandardGeographyQueryTask,...) {
var locationProvider: new StandardGeographyQueryLocationProvider({
geographyQueryTemplate: 'NAME:${STATE}',
queryParameters: {
countryID: 'US',
geographyLayerIDs: ['US.States']
},
standardGeographyQueryTask: new StandardGeographyQueryTask()
});
...
locationProvider.locate(graphicsArray,...).then(function(results) {
...
});
});Property Details
<String
StringA template to be used to build the query for Standard Geography query.
Sample:
// 1. Query template for State Name:
var locationProvider: new StandardGeographyQueryLocationProvider(
{
geographyQueryTemplate: "MajorSubdivisionName:${STATENAMEFIELD}",
queryParameters:{ sourceCountry: 'US', geographyLayers: 'US.States' },
standardGeographyQueryTask: new StandardGeographyQueryTask()
}
);
// 2. Query template for Countries by Name:
var locationProvider: new StandardGeographyQueryLocationProvider(
{
geographyQueryTemplate: "NAME:${COUNTRYFIELD}",
queryParameters:{ geographyLayers: 'countries' },
standardGeographyQueryTask: new StandardGeographyQueryTask()
}
);
// 3. Query template for US Zipcode
var locationProvider: new StandardGeographyQueryLocationProvider(
{
geographyQueryTemplate: 'ID:${f1}',
queryParameters: { geographyLayers: 'US.ZIP5', sourceCountry: 'US' },
standardGeographyQueryTask: new StandardGeographyQueryTask()
}
);
<String
StringThe geometry type of the returned features.
Known values:
"esriGeometryPoint" | "esriGeometryPolygon" | "esriGeometryPolyline"<Object
ObjectAn object that specifies the parameters to use in the Standard Geography query. Any of the properties in the
GeographyQuery properties table can be used in this object.<StandardGeographyQueryTask
StandardGeographyQueryTaskAn instance of the StandardGeographyQueryTask class.
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. |