| Package | com.esri.ags.virtualearth |
| Class | public class VEGeocoder |
| Inheritance | VEGeocoder  flash.events.EventDispatcher |
| Implements | mx.core.IMXMLObject |
| Since : | ArcGIS API for Flex 1.2 |
Note: Bing Maps tiles and geocoding were added in version 1.2.
See Locator for geocoding with ArcGIS Server.
See also
| Property | Defined By | ||
|---|---|---|---|
| addressToLocationsLastResult : Array
The addressToLocationsLastResult. | VEGeocoder | ||
| concurrency : String
Value that indicates how to handle multiple calls to the same task. | VEGeocoder | ||
| culture : String
The culture - provides localized strings in the language of the culture. | VEGeocoder | ||
| key : String
The Bing Maps Key. | VEGeocoder | ||
| requestTimeout : int
The request timeout in seconds. | VEGeocoder | ||
| showBusyCursor : Boolean
If true, a busy cursor is displayed while a service is executing. | VEGeocoder | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new VEGeocoder object. | VEGeocoder | ||
addressToLocations(query:String, responder:IResponder = null):AsyncToken
Sends a geocode request to Bing Maps to find candidates for a single address specified in the query argument. | VEGeocoder | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when an addressToLocations request successfully completes. | VEGeocoder | |||
| Dispatched when VEGeocoder fails. | VEGeocoder | |||
| addressToLocationsLastResult | property |
addressToLocationsLastResult:ArrayThe addressToLocationsLastResult.
This property can be used as the source for data binding.
public function get addressToLocationsLastResult():Array public function set addressToLocationsLastResult(value:Array):voidSee also
| concurrency | property |
concurrency:String
Value that indicates how to handle multiple calls to the same task. The default
value is multiple. The following values are permitted:
multiple Existing requests are not cancelled and the developer is
responsible for ensuring the consistency of returned data by carefully
managing the event stream. This is the default value.single Only a single request at a time is allowed on the task;
multiple requests generate a fault.last Making a request cancels any existing request. The default value is multiple.
This property can be used as the source for data binding.
public function get concurrency():String public function set concurrency(value:String):voidSee also
| culture | property |
culture:StringThe culture - provides localized strings in the language of the culture.
The default value is en-US.
This property can be used as the source for data binding.
public function get culture():String public function set culture(value:String):voidSee also
| key | property |
key:StringThe Bing Maps Key.
This property can be used as the source for data binding.
public function get key():String public function set key(value:String):voidSee also
| requestTimeout | property |
requestTimeout:intThe request timeout in seconds. A value less than or equal to zero prevents request timeout.
The default value is -1.
This property can be used as the source for data binding.
public function get requestTimeout():int public function set requestTimeout(value:int):void| showBusyCursor | property |
showBusyCursor:BooleanIf true, a busy cursor is displayed while a service is executing.
The default value is false.
This property can be used as the source for data binding.
public function get showBusyCursor():Boolean public function set showBusyCursor(value:Boolean):voidSee also
| VEGeocoder | () | Constructor |
public function VEGeocoder()Creates a new VEGeocoder object.
| addressToLocations | () | method |
public function addressToLocations(query:String, responder:IResponder = null):AsyncTokenSends a geocode request to Bing Maps to find candidates for a single address specified in the query argument. On completion, the addressToLocationsComplete event is fired and the optional callback responder is invoked.
Parameters
query:String — Text string to geocode.
| |
responder:IResponder (default = null) |
AsyncToken —
|
| addressToLocationsComplete | Event |
com.esri.ags.events.VEGeocoderEventcom.esri.ags.events.VEGeocoderEvent.ADDRESS_TO_LOCATIONS_COMPLETEDispatched when an addressToLocations request successfully completes.
Defines the value of thetype property of an addressToLocationsComplete event object.
| fault | Event |
mx.rpc.events.FaultEventmx.rpc.events.FaultEvent.FAULTDispatched when VEGeocoder fails.
<esri:VEGeocoder id="veGeocoder"
key="_thiscouldbeyourkey_Al0VE-H1tC0tk-eRubZv_EmyM6WZGqAsTyKS8G-WwCGK3"
/>var veGeocoder:VEGeocoder = new VEGeocoder(); veGeocoder.key = "_thiscouldbeyourkey_Al0VE-H1tC0tk-eRubZv_EmyM6WZGqAsTyKS8G-WwCGK3";