Class MMGeocoder

Object
   |
   +--MMGeocoder

class MMGeocoder

Defined in MultimapOpenAPI

Field Detail

error_code

String error_code

The error code produced by the last call to geocode().

result_set

Array result_set

The result set found by the last call to geocode(). An array of MMLocation objects.

MMGeocoder

MMGeocoder( <Function> callback )

The Multimap Geocoding Web Service convenience API.
This is a tool to link in to Multimap's Geocoding Web Service and display results on the page while having to write the minimum code possible.

Parameters:
callback - Function to call when geocoding completes.

_parseResultSet

Object _parseResultSet( json_result_set )

geocode

void geocode( <MMAddress> address )

Attempts to geocode an address, calling the callback function on completion. The geocoder object exposes two attributes that can be retrieved by the callback function. The first is result_set, which will contain an array of MMLocation objects. The second is error_code which will be undefined if no error occurred, otherwise it will return a valid error code.

Parameters:
address - The address to be geocoded.