Functions

Introduction

Once the Autoaddress control is initialised on your page, you have several functions available to your plugin instance to add extra flexibility and update default settings.

You can use these functions at any time after the plugin is initialised, i.e. in a Callback Event, page load, button clicks, etc..

How to call the functions

The below code snippet demonstrates the usage of functions within the Autoaddress control. 

In this code:

Autoaddress is an object representing the Autoaddress plugin, and you initialize it with configuration options.

apiKey should be replaced with your actual API key from the Account Center.

elementId  specifies the ID of the HTML element where the Autoaddress plugin will be rendered.

Here is an example on how to call the exposed functions from the Autoaddress variable returned from initialising the Autoaddress plugin.

<script type="text/javascript">  
var aa = Autoaddress({      
  apiKey: "YOUR_KEY",    
  elementId: "aa-control",  
  onAddressFormChange: function(address) { 
    // For example trigger a call to FormatEnteredAddress api on form change to keep address result in sync with live changes.
    aa.triggerFormatEnteredAddress(address)
  },
});

// Examples of how to toggle the display of the control
function showControl() {
  aa.showAutoaddressControl();
}

function hideControl() {
  aa.hideAutoaddressControl();
}

// Get the current version of the control
const version = aa.getVersion();

// Example of resetting the control
var resetButton = document.getElementById("reset-button");

// Add a click event listener to the button
resetButton.addEventListener("click", function () {
  // Call the reset function to clear the Autoaddress control     
  aa.reset(); 
});

// Example of fetching the address result from the control
async function handleSubmit(event) {
  event.preventDefault(); // Prevent the default form submission
  // Use the getAddressResult function to return full address result

  // Sample extracting address results
  const result = await aa.getAddressResult();
  const { lines, city, region, postcode, country } = result?.address;
  const addressLabel = result?.address?.label;

  // Sample extracting data attributes (if available)
  const { location = {} } = result?.data;
  const { latitude, longitude } = location;
}

</script>

List of available functions

The below table outlines the different functions currently available for the Autoaddress Javascript control.