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: VEGeocoder
[ AMD Module Require | Legacy Module Require ]
require(["esri/virtualearth/VEGeocoder"], function(VEGeocoder) { /* code goes here */ });
Description
(Added at v1.4)
Bing Maps geocoder. See Locator for geocoding with ArcGIS Server locators. If you are working with the 1.x version of the ArcGIS JavaScript API, you will need to use token.
Note: there are restrictions when using Bing Maps geocoding:
- Geocodes may not be stored for any purpose except caching for performance.
- Geocodes may not be displayed on any map other than a Bing Map.
Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new VEGeocoder(options) | Creates a new VEGeocoder object. |
Properties
| Name | Type | Summary |
|---|---|---|
| culture | String | Specifies the culture in which to return results. |
Methods
| Name | Return type | Summary |
|---|---|---|
| addressToLocations(query, callback?, errback?) | Deferred | Sends a geocode request to Bing Maps to find candidates for a single address specified in the query argument. |
| setCulture(culture) | None | Sets the culture in which to return results. |
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 |
|---|---|---|
| address-to-locations-complete | {
geocodeResults: < | Fires when VEGeocode.addressToLocation() has completed. |
| error | {
error: < | Fires when an error occurs when executing the task. |
Constructor Details
Creates a new VEGeocoder object.
Parameters:
< |
Required | See options list for parameters. |
options properties: < |
Optional | Key used to access Bing Maps maps. |
< |
Optional | Specifies the culture in which to return results. The default value is "en-US". For a list of supported cultures, see https://learn.microsoft.com/en-us/previous-versions/cc981048(v=msdn.10). |
Sample:
require([
"esri/virtualearth/VEGeocoder", ...
], function(VEGeocoder, ... ) {
var veGeocoder = new VEGeocoder({
bingMapsKey: 'Enter Bing Maps Key Here'
});
...
});
Property Details
<String
StringSpecifies the culture in which to return results. The default value is "en-US". For a list of supported cultures, see https://learn.microsoft.com/en-us/previous-versions/cc981048(v=msdn.10).
Default value:
en-USSee also: setCulture()
Method Details
Sends a geocode request to Bing Maps to find candidates for a single address specified in the query argument. On completion, the onAddressToLocationsComplete event is fired and the optional callback function is invoked.
Return type:
DeferredParameters:
< |
Required | The address to locate. |
< |
Optional | The function to call when the method has completed. The arguments in the function are the same as the onAddressToLocationsComplete event. |
< |
Optional | An error object is returned if an error occurs during task execution. |
Sample:
var query = "380 New York St, Redlands, CA, 92373"; veGeocoder.addressToLocations(query);
See also: on("address-to-locations-complete")
Sets the culture in which to return results.
Parameters:
< |
Required | The culture value. The default value is "en-US". For a list of supported cultures, see https://learn.microsoft.com/en-us/previous-versions/cc981048(v=msdn.10). |
See also: culture
Event Details
[ On Style Events | Connect Style Event ]
Fires when VEGeocode.addressToLocation() has completed. The result is an array of VEGeocodeResult. This is the same signature returned if the optional callback is specified. (Added at v3.6)
Event Object Properties:
< |
Contains an array of candidates that match the given address as well as their scores. |
Sample:
require([
"dojo/_base/connect", "esri/geometry/webMercatorUtils", "esri/symbols/SimpleMarkerSymbol",
"esri/Color", "esri/graphic", ...
], function(connect, webMercatorUtils, SimpleMarkerSymbol, Color, Graphic, ... ) {
connect.connect(veGeocoder, "onAddressToLocationsComplete", function(geocodeResults) {
var pointMeters = webMercatorUtils.geographicToWebMercator(geocodeResults[0].location);
var pointSymbol = new SimpleMarkerSymbol().setSize(15).setColor(new Color("blue"));
var locationGraphic = new Graphic(pointMeters,pointSymbol);
map.graphics.add(locationGraphic);
});
...
});
See also: addressToLocations()
Fires when an error occurs when executing the task. (Added at v3.6)
Event Object Properties:
< |
Error message returned in a JavaScript error object. |