Class: Geocoder

alk.geocode.Geocoder

An instance of this class has the functionality to access the ALK Geocoding/Locations service.

new alk.geocode.Geocoder(opt_options)

This constructor creates an API object that gives its user the ability to access the ALK Geocoding/Locations service.

Option Type Description
locationsServiceOptions alkx.LocationsServiceOptions

This option contains the options for the creation of the underling alkx.LocationsServiceOptions object.

Methods

geocode(opt_options)

This method calls out to the ALK Locations Service to retrieve results from the search parameters and the defaults set at the creation of the Geocoder object.

Option Type Description
address alkx.GeocodeAddress | alkx.NormalizedAddress

This option contains the address structure for the alk.geocode.Geocoder#geocode call. This option may also contain the 'normalized' address object that is returned in the response object.
listSize number

This option contains the maximum number of results to return in the response list.
success function

This option contains the callback function that will be called upon a successful return.
failure function

This option contains the callback function that will be called upon a failure return.