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
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 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. |
Property Details
Object that matches the Locator address fields to corresponding attribute names in the Graphic object.
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
An instance of a Locator object.
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.