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: LocatorLocationProvider
[ AMD Module Require | Legacy Module Require ]
require(["esri/tasks/locationproviders/LocatorLocationProvider"], function(LocatorLocationProvider) { /* code goes here */ });
Description
(Added at v3.12)
(Currently in beta)
The LocatorLocationProvider class uses a geocode service through the Locator object to generate or locate geometries using fields in the graphics that contain Street address informationSamples
Search for samples that use this class.Class hierarchy
esri/tasks/locationproviders/LocationProviderBase |_esri/tasks/locationproviders/LocationProviderRemoteBase |_esri/tasks/locationproviders/LocatorLocationProvider
Constructors
| Name | Summary |
|---|---|
| new LocatorLocationProvider(options) | Creates a new instance of the LocatorLocationProvider object. |
Properties
| Name | Type | Summary |
|---|---|---|
| addressFields | Object | Object that matches the Locator address fields to corresponding attribute names in the Graphic object. |
| geometryType | String | The geometry type of the returned features. |
| loaded | Boolean | Returns true when the load event has been fired. |
| locator | Locator | An instance of a Locator object. |
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 LocatorLocationProvider object.
Parameters:
< |
Required | Define the properties to use when creating the class. See options descriptions for further information. |
options properties: < |
Required | Object that matches the Locator address fields to corresponding attribute names in the Graphic object. |
< |
Required | An instance of a Locator object. |
Sample:
require([
"esri/tasks/locationproviders/LocatorLocationProvider",
"esri/tasks/locator",
...
], function(LocatorLocationProvider, Locator,...) {
var locationProvider = new LocatorLocationProvider({
addressFields: {
"Address": "Street",
"City": "City",
"State": "State",
"Zip": "Zip"
},
locator: new Locator("http://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer")
});
...
locationProvider.locate(graphicsArray).then(function(results) {
...
});
});Property Details
<Object
ObjectObject that matches the Locator address fields to corresponding attribute names in the Graphic object.
<String
StringThe geometry type of the returned features.
Known values:
"esriGeometryPoint" | "esriGeometryPolygon" | "esriGeometryPolyline"<Locator
LocatorAn instance of a Locator object.
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. |