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: CoordinatesLocationProvider
[ AMD Module Require | Legacy Module Require ]
Description
(Added at v3.12)
(Currently in beta)
The CoordinatesLocationProvider class uses the fields that contain Latitude and Longitude values to generate or locate geometries.Samples
Search for samples that use this class.Class hierarchy
esri/tasks/locationproviders.LocationProviderBase |_esri/tasks/locationproviders.LocationProviderClientBase |_esri/tasks/locationproviders.CoordinatesLocationProvider
Constructors
| Name | Summary |
|---|---|
| new esri.tasks.locationproviders.CoordinatesLocationProvider(options) | Creates a new instance of the CoordinatesLocationProvider object. |
Properties
| Name | Type | Summary |
|---|---|---|
| geometryType | String | The geometry type of the returned features. |
| inSpatialReference | SpatialReference | The Spatial Reference of the input geometries. |
| loaded | Boolean | Returns true when the load event has been fired. |
| xField | String | The attribute field in the graphic object that has the longitude (X) values. |
| yField | String | The attribute field in the graphic object that has the latitude (X) values. |
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 CoordinatesLocationProvider object.
Parameters:
< |
Required | Define the properties to use when creating the class. See options descriptions for further information. |
Property Details
<String
StringThe geometry type of the returned features.
Known values:
"esriGeometryPoint" | "esriGeometryPolygon" | "esriGeometryPolyline"<SpatialReference
SpatialReferenceThe Spatial Reference of the input geometries. Default is assumed to be WGS84 (WKID: 4326).
Default value:
SpatialReference({wkid:4326})<String
StringThe attribute field in the graphic object that has the longitude (X) values.
<String
StringThe attribute field in the graphic object that has the latitude (X) values.
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. |