MultiSearch Reference
MultiSearch Javascript API Reference- ApiOptions object Specification
- AutocompleteResponseItem object Specification
- DetailsResponseItem object Specification
- MultiApiOptions object Specification
- autocompleteAddress function definition
- autocompleteLocalities function definition
- autocompleteMulti function definition
- autocompletePlaces function definition
- autocompleteStore function definition
- detailsAddress function definition
- detailsLocalities function definition
- detailsMulti function definition
- detailsPlaces function definition
- detailsStore function definition
ApiOptions object Specification 🔗
Properties | |
key |
Type: String
Authentication key to be able to call the API. |
fallbackBreakpoint? |
Type: Number| Either |
minInputLength? |
Type: Number
Empty result will be sent by the API and no fallback will be triggered if the input length does not reach the minInputLength value.. |
params |
Type: Object
List of the API params to send.
Checkout:
Woosmap Localities
Woosmap Address
Woosmap Store
Google Places (Nb. The Places |
AutocompleteResponseItem object Specification 🔗
Properties | |
id |
Type: String
Item identifier (for |
api |
Type: 'localities'| The api the result was retrieved from |
description |
Type: String
Contains the human-readable name for the returned result. |
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. |
highlight |
Type: String
HTML description in which the entered term in the prediction result text are in |
types |
Type: Array
Array of types that apply to this item. |
item |
Type: Object
The item returned by the API “as is”. |
DetailsResponseItem object Specification 🔗
Properties | |
id |
Type: String
Item identifier (for |
name |
Type: String
Item name |
geometry |
Type: Object
Item geometry ( |
formatted_address |
Type: String
String containing the human-readable address of this item. |
types |
Type: Array
Types of the given item (like |
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 |
item |
Type: Object
Item returned by the API “as is”. |
MultiApiOptions object Specification 🔗
Properties | |
debounceTime? |
Type: Number
The amount of time in ms the autocomplete function will wait after the last received call before executing the next one. |
localities? |
Type: ApiOptions
Options for the Woosmap Localities API. |
address? |
Type: ApiOptions
Options for the Woosmap Address API. |
store? |
Type: ApiOptions
Options for the Woosmap Store API. |
places? |
Type: ApiOptions
Options for the Google Places API. |
autocompleteAddress function definition 🔗
autocompleteAddress
Function | function(input:String,options?:ApiOptions,callback?:Function) |
Return Value: [ 'Promise' ].<Array.<AutocompleteResponseItem>> Query the autocomplete Woosmap Address API. Check out the API documentation |
autocompleteLocalities function definition 🔗
autocompleteLocalities
Function | function(input:String,options?:ApiOptions,callback?:Function) |
Return Value: [ 'Promise' ].<Array.<AutocompleteResponseItem>> Query the autocomplete Woosmap Localities API. Check out the API documentation |
autocompleteMulti function definition 🔗
autocompleteMulti
Function | function(input:String,options?:MultiApiOptions,callback?:Function) |
Return Value: [ 'Promise' ].<Array.<AutocompleteResponseItem>> Query the different autocomplete APIs defined in the |
autocompletePlaces function definition 🔗
autocompletePlaces
Function | function(input:String,options?:ApiOptions,callback?:Function) |
Return Value: [ 'Promise' ].<Array.<AutocompleteResponseItem>> Query the autocomplete Google Places API. Check out the API documentation |
autocompleteStore function definition 🔗
autocompleteStore
Function | function(input:String,options?:ApiOptions,callback?:Function) |
Return Value: [ 'Promise' ].<Array.<AutocompleteResponseItem>> Query the autocomplete Woosmap Store API. |
detailsAddress function definition 🔗
detailsAddress
Function | function(id:String,callback?:Function) |
Return Value: [ 'Promise' ].<DetailsResponseItem> Query the details Woosmap Address API to get details of an address. Check out the API documentation |
detailsLocalities function definition 🔗
detailsLocalities
Function | function(id:String,callback?:Function) |
Return Value: [ 'Promise' ].<DetailsResponseItem> Query the details Woosmap Details API. Check out the API documentation |
detailsMulti function definition 🔗
detailsMulti
Function | function(id:String,api:'localities'|'address'|'store'|'places',callback?:Function) |
Return Value: [ 'Promise' ].<DetailsResponseItem> Query the details api to get details of an item. |
detailsPlaces function definition 🔗
detailsPlaces
Function | function(id:String,callback?:Function) |
Return Value: [ 'Promise' ].<DetailsResponseItem> Query the details Google Places API to get details of a place. Check out the API documentation |
detailsStore function definition 🔗
detailsStore
Function | function(id:String,callback?:Function) |
Return Value: [ 'Promise' ].<DetailsResponseItem> Query the search Woosmap Store API to get details of a store. Check out the API documentation |