Hide Table of Contents
esri/dijit/util
esri/layer/pixelFilters
esri/process
esri/workers
Class: LocatorLocationProvider

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 information

Samples

Search for samples that use this class.

Class hierarchy

esri/tasks/locationproviders/LocationProviderBase
|_esri/tasks/locationproviders/LocationProviderRemoteBase
  |_esri/tasks/locationproviders/LocatorLocationProvider

Constructors

NameSummary
new LocatorLocationProvider(options)Creates a new instance of the LocatorLocationProvider object.

Properties

NameTypeSummary
addressFieldsObjectObject that matches the Locator address fields to corresponding attribute names in the Graphic object.
geometryTypeStringThe geometry type of the returned features.
loadedBooleanReturns true when the load event has been fired.
locatorLocatorAn instance of a Locator object.

Methods

NameReturn typeSummary
locate(features, options?)DeferredAssigns 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

NameEvent ObjectSummary
error
{
  error: <Error>
}
Fires when an error occurs during locate.
loadFires after the provider has loaded.
locate-complete
{
  failed: <Graphic[]>,
  features: <Graphic[]>
}
Fires when the locate has completed.
locate-progress
{
  features: <Graphic[]>
}
Fires when the locate() method is in progress.
Constructor Details

new LocatorLocationProvider(options)

Creates a new instance of the LocatorLocationProvider object.
Parameters:
<Object> options Required Define the properties to use when creating the class. See options descriptions for further information.
options properties:
<Object> addressFields Required Object that matches the Locator address fields to corresponding attribute names in the Graphic object.
<Locator> locator 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> addressFields

Object that matches the Locator address fields to corresponding attribute names in the Graphic object.

<String> geometryType

The geometry type of the returned features.
Known values: "esriGeometryPoint" | "esriGeometryPolygon" | "esriGeometryPolyline"

<Boolean> loaded

Returns true when the load event has been fired.
Known values: true | false

<Locator> locator

An instance of a Locator object.
Method Details

locate(features, options?)

Assigns geometries to the array of Graphic objects.
Return type: Deferred
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 ]

error

Fires when an error occurs during locate.
Event Object Properties:
<Error> error Error message returned in a JavaScript error object.

load

Fires after the provider has loaded. The locate method can be called after this event.

locate-complete

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.

locate-progress

Fires when the locate() method is in progress.
Event Object Properties:
<Graphic[]> features A status message.