Localities Reference 1.0 (Deprecated)

Localities Javascript API Reference 1.0

AutocompleteService class

woosmap.localities.AutocompleteService

Localities Service to help you call the Localities API.

Constructor
`AutocompleteService`	`AutocompleteService(apiKey)` Parameters: `apiKey`: `String` Woosmap Public Key of your project Instantiate a new AutocompleteService Object

Methods

Methods
`getQueryPredictions`	`getQueryPredictions(params, callback, errorCallback, debounceTime)` Parameters: `params`: `AutocompleteRequest` query parameters `callback`: `SuccessCallback` executed on success `errorCallback`: `ErrorCallback` executed on failure `debounceTime`: `Number` prevents autocomplete requests from being sent unnecessarily often. Default is no debounce. Get the predictions array from an input value.


getQueryPredictions

getQueryPredictions(params, callback, errorCallback, debounceTime)

Parameters:

params: AutocompleteRequest query parameters
callback: SuccessCallback executed on success
errorCallback: ErrorCallback executed on failure
debounceTime: Number prevents autocomplete requests from being sent unnecessarily often. Default is no debounce.

Get the predictions array from an input value.

Properties
`admin_0`	Type: `String` The country name associated to the prediction
`admin_1`	Type: `String` The area name associated to the prediction
`description`	Type: `String` The suggested formatted answer
`location`	Type: `LatLngLiteral` The location object
`matched_substrings`	Type: `MatchedElements` A set of substrings of each field (description, name, admin_0, admin_1) that match elements in the input. It can be used to highlight those substrings. Each substring is identified by an offset and a length.
`name`	Type: `String` The location name
`postal_codes`	Type: `String \| String[]` Array of postal codes for suggested location (only returned for localities predictions)
`postal_town`	Type: `String` Contains the larger city (or the post office city) for a postal_code (only available on suggestions with type: postal_code).
`type`	Type: `String` requested prediction type (‘locality’, ‘postal_code’, ‘country’, ‘admin_level’, ‘train_station’, ‘metro_station’, ‘shopping’, ‘museum’, ‘zoo’, ‘amusement_park’, ‘art_gallery’, ‘tourist_attraction’ or ‘airport’)
`viewpoint`	Type: `LatLngBoundsLiteral` The preferred viewpoint when displaying this Locality on a map. This property will be null if the preferred viewport for the Locality is not known.

Properties
`apiKey?`	Type: `String` the public key of your Woosmap project. To use this parameter a dedicated option on your licence is needed. Please contact us if you are interested in using this parameter and you do not have subscribed the proper option yet.
`components?`	Type: `ComponentRestrictions` restricts predictions to selected components
`data?`	Type: `String` the data set to use, accepted values `standard`, `advanced`.
`extended?`	Type: `String` param to extend the search, accepted value is `postal_code` to enable search of localities by name or postal code.
`input`	Type: `String` Value to search for predictions
`language?`	Type: `String` expected response language
`types?`	Type: `String \| String[]` requested prediction type (‘locality’, ‘postal_code’, ‘country’, ‘admin_level’, ‘airport’, ‘train_station’, ‘metro_station’, ‘shopping’, ‘museum’, ‘zoo’, ‘amusement_park’, ‘art_gallery’, ‘tourist_attraction’ or undefined for ‘locality’ + ‘postal_code’)

Properties
`components`	Type: `ComponentRestrictions` restricts predictions to selected components
`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 code
`input`	Type: `String` User input
`language`	Type: `String` expected response language (ISO 639-1 code). Default is the country local or browser language.
`types`	Type: `String \| String[]` The types queried (supports ‘locality’, ‘postal_code’, ‘country’, ‘admin_level’, ‘train_station’, ‘metro_station’, ‘shopping’, ‘museum’, ‘zoo’, ‘amusement_park’, ‘art_gallery’, ‘tourist_attraction’ and ‘airport’ ; omit param for ‘locality’ + ‘postal_code’)

Properties
`localities`	Type: `AutocompleteLocalities` Array with Autocomplete Localities

Properties
`country`	Type: `String \| 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.

Type: Function

Callback executed when query fails

Function
`ErrorCallback`	`ErrorCallback(errorCode, errorText)` Parameters: `errorCode`: `Number` the http error code `errorText`: `String` the error description Callback executed when query fails

Properties
`lat`	Type: `String` The latitude value
`lng`	Type: `String` The longitude value

Properties
`admin_0`	Type: `MatchedSubstring[]` (optional) A set of substrings that match the admin_0 field
`admin_1`	Type: `MatchedSubstring[]` (optional) A set of substrings that match the admin_1 field
`description`	Type: `MatchedSubstring[]` (optional) A set of substrings that match the description field
`name`	Type: `MatchedSubstring[]` (optional) A set of substrings that match the name field
`postal_town`	Type: `MatchedSubstring[]` (optional) A set of substrings that match the postal_town field

Properties
`length`	Type: `Number` The length of the substring
`offset`	Type: `Number` The offset to the substring’s start within the AutocompleteLocalities field string

Type: Function

Callback executed when query is successful

Function
`SuccessCallback`	`SuccessCallback(autocompleteResponse)` Parameters: `autocompleteResponse`: `AutocompleteResponse` Callback executed when query is successful

Was this article helpful?

Have more questions? Submit a request