Packagecom.google.maps.interfaces
Interfacepublic interface IClientGeocoder extends IWrappableEventDispatcher, flash.events.IEventDispatcher, IWrappable
ImplementorsClientGeocoder

IClientGeocoder is the interface implemented by client geocoder object. A client geocoder communicates with Google servers to obtain geocodes for user specified addresses. In addition, a geocoder maintains its own cache of addresses, which allows repeated queries to be answered without a round trip to the server.



Public Properties
 PropertyDefined by
 InheritedinterfaceChain : Array
List of interfaces for wrapping this object.
IWrappable
 Inheritedwrapper : Object
Instance of the cross-domain wrapper for this object.
IWrappable
Public Methods
 MethodDefined by
  
geocode(address:String):void
Initiates a geocoding request.
IClientGeocoder
 Inherited
Retrieves the base event dispatcher object that allows access to event dispatching capability for cross-domain objects.
IWrappableEventDispatcher
  
Retrieves the geocoder object's options.
IClientGeocoder
  
resetCache():void
Resets the geocoding cache, clearing all results retrieved by this and other ClientGeocoder objects.
IClientGeocoder
  
reverseGeocode(latLng:LatLng):void
Initiates a reverse geocoding request.
IClientGeocoder
  
Updates the geocoder options.
IClientGeocoder
Method detail
geocode()method
public function geocode(address:String):void

Initiates a geocoding request. Dispatches GeocodingEvent.GEOCODING_SUCCESS or GeocodingEvent.GEOCODING_FAILURE on completion.

Parameters
address:String — Address to geocode.

Throws
— A null or empty address will cause an ArgumentError to be thrown.
getOptions()method 
public function getOptions():ClientGeocoderOptions

Retrieves the geocoder object's options. Use the setOptions() method to modify geocoder options.

Returns
ClientGeocoderOptions — Full set of options for the geocoder object.
resetCache()method 
public function resetCache():void

Resets the geocoding cache, clearing all results retrieved by this and other ClientGeocoder objects.

reverseGeocode()method 
public function reverseGeocode(latLng:LatLng):void

Initiates a reverse geocoding request. Dispatches GeocodingEvent.GEOCODING_SUCCESS or GeocodingEvent.GEOCODING_FAILURE on completion.

Parameters
latLng:LatLng — LatLng to reverse geocode.

Throws
— A null LatLng will cause an ArgumentError to be thrown.
setOptions()method 
public function setOptions(options:ClientGeocoderOptions):void

Updates the geocoder options. The options parameter may specify a complete or partial set of geocoder options.

Parameters
options:ClientGeocoderOptions — New full or partial set of geocoder options.