Javascript reference
AddressFinder.Widget class
This widget adds the international address autocomplete service to a simple form field.
To view the address autocomplete and metadata parameters and the data returned by this service, view the metadata page. The code examples page demonstrates many of these configuration options.
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. |
setCountry() | country_code: String | AddressFinder.Widget | Sets a country 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 | {strict: "2"} | Additional parameters to filter the address results. NZ Address params, AU Address params, and International Address params. The Code Examples page has some good examples. |
address_metadata_params | Object | nil | Additional parameters to adjust the values returned with address metadata. NZ Address Metadata params, AU Address Metadata params, International Address Metadata params. |
base_url | String | https://api.addressfinder.io | The base URL endpoint for API calls and CSS resources. |
canonical | Boolean | true | Force the selection of the canonical address when an aliased address is selected. |
container | Object | document.body | The element that wraps an input field that AddressFinder will use. 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. | 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. |
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. |
Events
| Event | Callback Arguments | Description |
|---|---|---|
"result:select" | selectedAddress:String, metadata:Object | Fired when any result is selected. Metadata depends on the search criteria supplied. Metadata could be Australian Address metadata, Australian Location metadata, New Zealand Address metadata, New Zealand Location metadata, or New Zealand Point of Interest metadata. |
"address:select" | selectedAddress:String, metadata:Object | Just like "result:select", but only fired when an address is selected. Metadata could be Australian Address metadata or New Zealand Address metadata. |
"address:select:pre" | selectedAddress:String, metadata:Object | Fired immediately when an address is selected, before an info request for extended data is made. |
"results:update" | Fired when all services have updated their results. | |
"results:empty" | Fired when there are no results to display. |
AddressFinder.Service class
Constructor
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 to 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" | selectedAddress:String, metadata:Object | Fired when a result from this service is selected. |