Localities Widget Reference 2.0

Localities Javascript Widget Reference 2.0
  1. Autocomplete class 
  2. AutocompleteParameters object Specification 
  3. AutocompleteResponse object Specification 
  4. AutocompleteResponseItem object Specification 
  5. ComponentRestrictions object Specification 
  6. DetailsResponseItem object Specification 

Autocomplete class 🔗


Autocomplete(inputId:String, customConfig?:AutocompleteParameters)

addListener(eventName, callback)

Return Value: Event

Adds an event listener to the widget Can be removed using removeListener() with the same arguments


Return Value: AutocompleteResponse

Returns the latest search results


Return Value: DetailsResponseItem

Returns the latest user-selected locality among search results

removeListener(eventName, callback)

Removes given event listener from the widget


Sets the component restrictions


Sets the custom description to query


Sets new config options


Sets the types to query

AutocompleteParameters object Specification  🔗

minLength Type: Number

Number of characters before sending request to Localities API

customDescription Type: String

This parameter allows to choose the description format for all or some of the suggestion types selected. The custom formats are described as follows : custom_description=type_A:"{field_1}, {field_2}, [...]"|type_B:"{field_1}, {field_2}, [...]" .

components Type: ComponentRestrictions

restricts predictions to selected components

types Type: String|Array.<String>

The types queried (example ‘locality’, ‘postal_code’, ‘country’ ; omit param for ‘locality’ + ‘postal_code’)

data Type: String

Defaults to ‘standard’, can be set to ‘advanced’ to retrieve postal codes outside western Europe

extended Type: String

can be set to ‘postal_code’ to search localities by name or postal codes

language Type: String

expected response language. Default is the country local or browser language

firstTabIndex Type: Number

all tabindexes in Autocomplete will start from that tabindex. Defaults to 0.

debounceTime Type: Number

prevents autocomplete requests from being sent unnecessarily often. Default is no debounce.

AutocompleteResponse object Specification  🔗

localities Type: AutocompleteResponseItem

Array with Autocomplete items

AutocompleteResponseItem object Specification  🔗

public_id Type: String

Item identifier

description Type: String

The suggested formatted answer

matched_substrings Type: Array

Contains an array with offset value and length. These describe the location of the entered term in the prediction result text, so that the term can be highlighted if desired.

type Type: String

requested prediction type (‘locality’, ‘postal_code’, ‘country’, ‘admin_level’, ‘train_station’, ‘metro_station’, ‘shopping’, ‘airport’, ‘museum’, ‘zoo’, ‘amusement_park’, ‘art_gallery’, ‘tourist_attraction’, ‘address’)

ComponentRestrictions object Specification  🔗

country Type: String|Array.<String>

Restricts predictions to the specified country (ISO 3166-1 Alpha-2 country code, case insensitive). For example, ‘fr’, ‘gb’, or ‘es’. You can provide a single one, or an array of country code strings.

DetailsResponseItem object Specification  🔗

public_id Type: String

Item identifier

name Type: String

Item name

geometry Type: Object

Item geometry ({location:{lat, lng}, viewport: {northeast: {lat, lng}, southwest: {lat, lng}}})

formatted_address Type: String

String containing the human-readable address of this item.

types Type: Array

Types of the given item (like locality or postal_code)

address_components Type: Array

Array containing the separate components applicable to this address. Each component has a long name (full text description or name of the address component), a short name (abbreviated textual name for the address component, if available) and types (array indicating the type of the address component like locality, street_number…)

Was this article helpful?
Have more questions? Submit a request