v5 v4

Class: Autocomplete

cercalia.service.Autocomplete

This class lets you convert a <input type="text"> HTML element, into a suggest address search.

new cercalia.service.Autocomplete(options)

temp/jsdocinputdirs/cercalia.service.autocomplete.js, line 10
Name Type Description
options
Name Type Description
callbackFunction function | undefined optional

Callback function when selecting autocomplete element.
onInputFunction function | undefined optional

Callback function when user is typing in text input.
inputId function | undefined optional

<input type="text"> element ID where create the Autocomplete. Mandatory.
hnrt boolean | undefined optional

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 | undefined optional

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

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 | undefined optional

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 | undefined optional

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 | undefined optional

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 optional

Search closest real house number in suggest. Default: false.
searchFilterEntity string | undefined optional

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

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'].

Methods

close()

temp/jsdocinputdirs/cercalia.service.autocomplete.js, line 414

Close autocomplete div.

getClass(){string}

temp/jsdocinputdirs/cercalia.service.autocomplete.js, line 646
Returns:
ClassName. Value cercalia.service.Autocomplete

getGeocoding(){Object}

temp/jsdocinputdirs/cercalia.service.autocomplete.js, line 168
Returns:
Return a JSON object with the last information.

setCallbackfunction(callbackfunction)

temp/jsdocinputdirs/cercalia.service.autocomplete.js, line 156

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

Name Type Description
callbackfunction function

setSearchFilterEntity()

temp/jsdocinputdirs/cercalia.service.autocomplete.js, line 236

Set filter by municipality / region / subregion (by entity code). You can mix that entities. Parameter examples:
ESP170792,ESPCAT,ES08 or * [ESP170792, ESPCAT, ES08]
ESP,ESP08,ESP17,PRT,AND.

setSearchFilterType(type)

temp/jsdocinputdirs/cercalia.service.autocomplete.js, line 277

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

setSearchInsideCountry(countriesId)

temp/jsdocinputdirs/cercalia.service.autocomplete.js, line 177

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

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

setSearchInsideLocality(localityId)

temp/jsdocinputdirs/cercalia.service.autocomplete.js, line 222

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

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

setSearchInsideMunicipality(municipalityId)

temp/jsdocinputdirs/cercalia.service.autocomplete.js, line 211

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

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

setSearchInsideProvince(provinceId)

temp/jsdocinputdirs/cercalia.service.autocomplete.js, line 200

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

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

setSearchInsideRegion(regionsId)

temp/jsdocinputdirs/cercalia.service.autocomplete.js, line 189

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

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

setSearchPreferredEntity(entities)

temp/jsdocinputdirs/cercalia.service.autocomplete.js, line 269

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'].

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

Entities.

setSearchPriorityEntity(entities)

temp/jsdocinputdirs/cercalia.service.autocomplete.js, line 255

Set preferred municipality / region / subregion (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 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
Parameter examples:
['ESP170792', 'AND', 'ESP,FRA'].
['ESPCAT', 'ESPMAD', 'PRT,AND,FRA'].

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

Entities.