Widget documentation
AddressFinder.Widget class
Constructor
| Constructor | Parameters | Description |
|---|---|---|
AddressFinder.Widget() | input:Element, api_key:String, country_code:String, options?:Object | Attaches a new widget to the specified input element. |
Methods
| Method | Parameters | Return Value | Description |
|---|---|---|---|
on() | event_name:String, callback:Function | AddressFinder.Widget | Subscribes to a specified event. |
trigger() | event_name:String, arguments… | AddressFinder.Widget | Manually fires a specified event. |
setOption() | option_name:String, value:* | AddressFinder.Widget | Sets an option after the widget has been initialised. |
getOption() | option_name:String | AddressFinder.Widget | Gets the current value of the specified option. |
addService() | name:String, search_function:Function | AddressFinder.Service | Function to add an additional third-party search. |
disable() | AddressFinder.Widget | Disables the AddressFinder widget. The autocomplete function will stop operating until it is re-enabled. | |
enable() | AddressFinder.Widget | Re-enables a disabled AddressFinder widget. |
Options
| Option | Type | Default | Description |
|---|---|---|---|
address_params | Object | {highlight: 1} | Additional parameters to filter the address results. Add any of the Address Autocomplete API parameters. The Code Demos page has some good examples. |
address_metadata_params | Object | nil | Additional parameters to adjust the values returned from the Address Metadata API. Add any of the Address Metadata API parameters. |
base_url | String | https://api.addressfinder.io | The base URL endpoint for API calls and CSS resources. |
byline | Boolean | true | Show the Powered by AddressFinder message in the footer. |
canonical | Boolean | true | Force the selection of the canonical address when an aliased address is selected. |
container | Object | document.body | The element that wraps in input field that AddressFinder will use. This is useful when embedding the widget within a scrolling panel. The Code Demos page has some good examples. |
empty_class | String | 'af_empty' | CSS class name to be applied to the li element containing the empty_content message. |
empty_content | String | No addresses were found. This could be a new address, or you may need to check the spelling. Learn more | Message to display to users when there are no found addresses or locations. |
footer_class | String | 'af_footer' | CSS class name to be applied to the li element containing the footer. |
hover_class | String | 'af_hover' | CSS class name to be applied to the li element of a highlighted result. |
ignore_returns | Boolean | true | Ignore the use of the enter key when no list item is selected. |
item_class | String | 'af_item' | CSS class name to be applied to the li element of a result. |
list_class | String | 'af_list' | CSS class name to be applied to the ul element containing the results. |
location_params | Object | {highlight: 1} | Additional parameters to filter the location results. Add any of the Location Autocomplete API parameters. The Code Demos page has some good examples. |
manual_style | Boolean | false | If true, the widget will not embed the default stylesheet, allowing a custom stylesheet to be used. (Can only be set when widget is constructed). |
max_results | Integer | 10 | Maximum number of results to display. |
position | String | 'absolute' | Use a different positioning value for the list_class element. When embedding AddressFinder within a fixed position element, using a matching fixed position value will ensure the popup list appears below the input element. |
show_addresses | Boolean | true | Set to false to hide address results. |
show_locations | Boolean | false | Set to true to return location (street, suburb, city and region) results. |
show_nearby | Boolean | false | Enable the nearby address helper (uses device's GPS to suggest addresses at current location) |
show_points_of_interest | Boolean | false | Set to true to return points of interest (e.g. hospitals, schools and churches) results. |
Events
| Event | Callback Arguments | Description |
|---|---|---|
"results:update" | Fired when all services have updated their results. | |
"results:empty" | Fired when there are no results to display. | |
"result:select" | value:String, data:Object | Fired when any result is selected. See Address Info Response and Location Info Response page for further specification of the data field. |
"address:select" | value:String, data:Object | Just like "result:select", but only fired when an address is selected. See Address Info Response page for further specification of the data field. |
"address:select:pre" | value:String, data:Object | Fired immediately when an address is selected, before an info request for extended data is made. See Address Info Response page for further specification of the data field. |
"location:select" | value:String, data:Object | Just like "result:select", but only fired when a location is selected. See Location Info Response page for further specification of the data field. |
"location:select:pre" | value:String, data:Object | Fired immediately when an location is selected, before an info request for extended data is made. See Location Info Response page for further specification of the data field. |
AddressFinder.Service class
Constuctor
AddressFinder.Service is returned from the AddressFinder.Widget#addService method.
Methods
| Method | Parameters | Return Value | Description |
|---|---|---|---|
on() | event_name:String, callback:Function | AddressFinder.Service | Subscribes an a specified event. |
trigger() | event_name:String, arguments… | AddressFinder.Service | Manually fires a specified event. |
setOption() | option_name:String, value:* | AddressFinder.Service | Sets an option after the widget has been initialised. |
getOption() | option_name:String | AddressFinder.Service | Gets the current value of the specified option. |
Options
| Option | Type | Default | Description |
|---|---|---|---|
renderer | Function | Allows a function to be defined to format how the result will be displayed. The function will be passed two arguments, the value and the data, and must return a string. |
Events
| Event | Callback Arguments | Description |
|---|---|---|
"result:select" | value:String, data:Object | Fired when a result from this service is selected. |
AddressFinder.NZSelectedAddress class
Constuctor
| Constructor | Parameters | Description |
|---|---|---|
AddressFinder.NZSelectedAddress() | fullAddress:String, metaData:Object | A convenience wrapper around the response from the Address Metadata API |
Methods
| Method | Parameters | Return Value | Description |
|---|---|---|---|
address_line_1() | String | First line of the non-city/suburb/postcode portion of the address. | |
address_line_2() | String | Second line of the non-city/suburb/postcode portion of the address. | |
address_line_1_and_2() | String | First and second lines of the non-city/suburb/postcode portion of the address joined together. | |
suburb() | String | The suburb of the address. | |
city() | String | The city of the address. | |
postcode() | String | The NZ Post postcode of the address. |