| SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A geocoder client is necessary in order to convert an address into coordinates.
This class is part of the module geocoding.
| Constructor Summary | |
IWGeocoderClient()
Creates a new geocoder client. |
|
| Method Summary | |
void
|
geocodeAddress(address, maxHits, object)
Geocodes an address into a coordinate. |
void
|
geocodeAddressString(address, countryCode, maxHits, object)
Geocode an address. |
void
|
reverseGeocodeByHits(coordinate, hits, object)
Searchs up to the specified number of addresses for a given coordinate. This is an asynchronous operation which will trigger an onreversegeocode event. |
void
|
reverseGeocodeByRadius(coordinate, radius, object)
Searchs addresses for a given coordinate within the specified radius. This is an asynchronous operation which will trigger an onreversegeocode event. |
String
|
toString()
Returns a string representation. |
| Event Summary | |
void
|
geocode(event)
The geocode event is fired when the address is geocoded. Register an event listener with IWEventManager.addListener(theGeocoderClient, 'ongeocode', yourHandlerMethod(event)); to receive the event. |
void
|
reversegeocode(event)
The reversegeocode event is fired when the coordinate is matched to addresses. Register an event listener with IWEventManager.addListener(theRouterClient, 'onreversegeocode', yourHandlerMethod(event)); to receive the event. |
| Constructor Detail |
IWGeocoderClient()
| Method Detail |
void geocodeAddress(address, maxHits, object)
IWAddress address - an address
number maxHits - maximum number of returned addresses (optional)
Object object - reserved for a user defined object (optional)
void
void geocodeAddressString(address, countryCode, maxHits, object)
String address - the address to geocode, e.g. 'Riemenschneiderstr. 11, 53225 Bonn'
String countryCode - the country the address is in, e.g. 'D'
number maxHits - maximum number of returned addresses (optional, defaults to 1)
Object object - reserved for a user defined object (optional)
void
void reverseGeocodeByHits(coordinate, hits, object)
IWCoordinate coordinate - the search coordinate
number hits - the number of addresses to return
Object object - reserved for a user defined object (optional)
void
void reverseGeocodeByRadius(coordinate, radius, object)
IWCoordinate coordinate - the search coordinate
number radius - search radius in meter (max. 10 km)
Object object - reserved for a user defined object (optional)
void
String toString()
String
| Event Detail |
void geocode(event)
Register an event listener with IWEventManager.addListener(theGeocoderClient, 'ongeocode', yourHandlerMethod(event)); to receive the event.
IWGeocodingEvent event - the geocoding event
void
void reversegeocode(event)
Register an event listener with IWEventManager.addListener(theRouterClient, 'onreversegeocode', yourHandlerMethod(event)); to receive the event.
IWReverseGeocodingEvent event - the reverse geocoding event
void