jsdoc

$.ui.simplicityNokiaGeocoder

Namespace $.ui.simplicityNokiaGeocoder

A Nokia geocoder.

Nokia geocoder widget. Also provides a jQueri UI autocomplete source.


Defined in: ui.simplicityNokiaGeocoder.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
<static>  
$.ui.simplicityNokiaGeocoder.options
Widget options.
Method Summary
Method Attributes Method Name and Description
<static>  
$.ui.simplicityNokiaGeocoder.autocompleteSource()
Create an autocomplete source function that returns normalized geocoded addresses.
<static>  
$.ui.simplicityNokiaGeocoder.geocode(geocodeRequest, callback)
Perform geocoding of the geocodeRequest calling the callback on completion.
<private> <static>  
$.ui.simplicityNokiaGeocoder.normalizeAddress()
Normalize a single geocoded address.
<private> <static>  
$.ui.simplicityNokiaGeocoder.normalizeResults()
Normalize the geocoder response.
Namespace Detail
$.ui.simplicityNokiaGeocoder
See:
Nokia Maps - JavaScript API documentation.
Field Detail
<static> $.ui.simplicityNokiaGeocoder.options
Widget options.
maxResults
Maximum number of results to request. Defaults to 5.
debug
Enable logging of key events to console.log. Defaults to false.
Method Detail
<static> $.ui.simplicityNokiaGeocoder.autocompleteSource()
Create an autocomplete source function that returns normalized geocoded addresses.

<static> $.ui.simplicityNokiaGeocoder.geocode(geocodeRequest, callback)
Perform geocoding of the geocodeRequest calling the callback on completion.

Triggers two events.

request
Final step before sending the geocode request, it is passed as the custom object to this event to allow for manipulation.
response
Final step before calling the callback with the geocode response to allow for manipulation. Triggered after any normalization phase.

The custom object passed to this event looks like so:

    {
      vendor: {
        // Original vendor response
      },
      items: [
        // Array of normalized items, see normalizeResults.
      ]
    }
    
Parameters:
geocodeRequest
The request as expected by the upstream geocode vendor.
callback
The callback triggered at geocode completion. Is given one argument which is the same as custom Object passed to the response event.

<private> <static> $.ui.simplicityNokiaGeocoder.normalizeAddress()
Normalize a single geocoded address. This gets injected as the value of the item object.

<private> <static> $.ui.simplicityNokiaGeocoder.normalizeResults()
Normalize the geocoder response. Returns an array of items.
  Example output
  [
    {
      value: 'Statue of Liberty, New York, NY 11231, USA',
      latitude: 40.6892437,
      longitude: -74.0445142,
      vendor: {
        // Upstream vendor response for this single location
      }
    }
  ]

Documentation generated by JsDoc Toolkit 2.4.0