Class: Autocomplete

cercalia.service.Autocomplete


This class add suggest autocomplete funcionality to an input. This input must be an HTML element <cercalia-autocomplete id="xxx">

new cercalia.service.Autocomplete(options)

src/cercalia/service/autocomplete.js, line 22
Name Type Description
options

Options

Name Type Description
callbackFunction function | undefined

Callback function when selecting autocomplete element.

autocompleteId string

<cercalia-autocomplete id="xxxx"> element ID where create add autocomplete functionality. Mandatory. Required.

placeholder string | undefined

Input placeholder. If not specified default is Address.

hnrt boolean | undefined

Apply a tolerance in house number ranges. Cercalia suggest search prioritize address that contains the house numbers searched. This parameters lets you apply a tolerance in the house numbers ranges available in the database (+/-50 numbers in general, and +/- 500 in USA), in order to avoid some gaps in this database. Values:
false: don’t apply. Default value
true: apply

searchInsideCountry string | null | undefined

Autocomplete search inside a country (3 characters ISO code), for exemple: ESP. Default value null (all countries).

searchInsideRegion string | null | undefined

Autocomplete search inside a region (Country ISO code + Region code), for exemple: ESPMAD or several regions, for example: ESPCAT,ESPMAD,ESPVAL. Please, contact with Nexus if you need to know region codes.

searchInsideProvince string | null | undefined

Autocomplete search inside a province (Country ISO code + Province code), for exemple: ESP08 (Barcelona), ESP17 (Girona) or several provinces, for example: ESP08,ESP17. Please, contact with Nexus if you need to know province codes.

searchInsideMunicipality string | null | undefined

Autocomplete search inside a municipality (Country ISO code + Province code), for exemple: ESP410917 (Sevilla), ESP502973 (Zaragoza) or several municipality, for example: ESP08,ESP17. Please, contact with Nexus if you need to know municipality codes.

searchInsideLocality string | null | undefined

Autocomplete search inside a locality for exemple: ESP17240205565747 (Barcelona), ESP17240205565484 (Badalona) or several localities, for example: ESP17240205565747,ESP17240205565484. Please, contact with Nexus if you need to know locality codes.

searchClosestHouseNumber boolean | undefined

Search closest real house number in suggest. Default: false.

searchFilterEntity string | undefined

Set filter by municipality / region / subregion / country (by entity code). You can mix that entities. Examples:
ESP170792,ESPCAT,ES08
SolrItem ESP,ESP08,ESP17,PRT,AND.

searchPriorityEntity string | Array.<string> | undefined

Set preferred municipality / region / subregion / country (by entity code). This filter, prioritizes the results that are in the specified regions above the other candidates, but does not eliminate the results from other regions or countries. This filter can be combined with the "csr" filter for maximum results filter beyond the preferred. Example: ESPVAL. In case you need to prioritize candidates in the list of preferred regions, the regions may be separated by parameters according to priority level: first element: maximum priority, second element: second level priority, etc
Examples:
['ESP170792', 'AND', 'ESP,FRA'].
['ESPCAT', 'ESPMAD', 'PRT,AND,FRA'].

searchPreferredEntity string | Array.<string> | undefined

Set preferred municipality / region / subregion / country (by entity code). Not compatible with "searchPriorityEntity". This filter, use a soft prioritizaton of the results that are in the specified regions above the other candidates, but does not eliminate the results from other regions or countries. This filter can be combined with the rsc filter for maximum results filter beyond the preferred. Example: ESPVAL. In case you need to prioritize candidates in the list of preferred regions, the regions may be separated by parameters according to priority level: first element: maximum priority, second element: second level priority, etc. ['ESP170792', 'AND', 'ESP,FRA'].
['ESPCAT', 'ESPMAD', 'PRT,AND,FRA'].

poiCategories string | Array.<string> | undefined

Set POI categories. If not specified Cercalia will return default POI categories. Categories. For example: ['C012', 'D00CAM', 'C027', 'C016']

Extends

Methods

close()

src/cercalia/service/autocomplete.js, line 420

Close autocomplete div.

getClass(){string} inherited

src/cercalia/object.js, line 41
Returns:
Get Class name of object

getElement(){PolymerCercaliaElement.Autocomplete}

src/cercalia/service/autocomplete.js, line 849
Returns:
Autocomplete element.

getGeocoding(){cercaliax.GeEntity|null|undefined}

src/cercalia/service/autocomplete.js, line 213
Returns:
Return a JSON object with the last information.

getId(){string} inherited

src/cercalia/object.js, line 33
Returns:
Unique Id.

setCallbackFunction(callbackFn)

src/cercalia/service/autocomplete.js, line 203

Assign a callback function after selecting a candidate from the suggest list

Name Type Description
callbackFn function

Callback Function.

setPoiCategories(categories)

src/cercalia/service/autocomplete.js, line 326

Set POI categories. If not specified Cercalia will return default POI categories.

Name Type Description
categories string | Array.<string> | null

Categories. For example: ['C012', 'D00CAM', 'C027', 'C016']

setSearchFilterType(type)

src/cercalia/service/autocomplete.js, line 338

Search within type specified. Possible values are: st (streets), ct (locality), p (pois), all|null. It is possible specify more than one value. Example : st,ct

Name Type Description
type string | Array.<string> | null

Type or array of types. For example: ['ct','pois','st'].

setSearchInsideCountry(countriesId)

src/cercalia/service/autocomplete.js, line 222

Search inside a country. For example: 'ESP,FRA,GBR' or ['ESP','FRA','GBR']

Name Type Description
countriesId string | Array.<string> | null

Country or array of countries id.

setSearchInsideLocality(localityId)

src/cercalia/service/autocomplete.js, line 270

Search inside a locality. For example: ESP17240205544993 (Vallecas), ESP17240205545872 (La Barceloneta), etc..

Name Type Description
localityId string | Array.<string> | null

Locality or array of localities id.

setSearchInsideMunicipality(municipalityId)

src/cercalia/service/autocomplete.js, line 258

Search inside a municipality. For example: ESP280796 (Madrid), ESP080193 (Barcelona), etc..

Name Type Description
municipalityId string | Array.<string> | null

Municipality id or array of municipality id.

setSearchInsideProvince(provinceId)

src/cercalia/service/autocomplete.js, line 246

Search inside a region. For example: ESP17 (Girona), ESP08 (Barcelona) etc..

Name Type Description
provinceId string | Array.<string> | null

Region or array of regions id.

setSearchInsideRegion(regionsId)

src/cercalia/service/autocomplete.js, line 234

Search inside a region. For example: ESPMAD (Comunidad de Madrid), ESPCAT (Catalunya), etc..

Name Type Description
regionsId string | Array.<string> | null

Region or array of regions id.

setValue(text, opt_openSuggestions)

src/cercalia/service/autocomplete.js, line 859

Change value of autocomplete and optionally open suggestions or search coordinate.

Name Type Description
text string

Text

openSuggestions boolean

Open suggest after change input value or search introduced coordinate.

submit()

src/cercalia/service/autocomplete.js, line 392

Force submit as press key enter event. That could be useful to search for coordinates