new cercalia.service.Geocoding(options)
Geocoding service constructor
Name | Type | Description |
---|---|---|
options |
cercaliax.service.GeocodingOptions |
Opciones Geocoding |
Members
-
address{string}
-
Street name filter with house number
-
city{string}
-
Town name filter (ctn)
-
cityId{string}
-
Town code filter (ctc)
-
country{string}
-
Country name filter (ctryn)
-
countryId{string}
-
Country code filter (ctryc)
-
fullSearch{string}
-
Use all candidates parameters (fullsearch)
-
housenumber{number}
-
House number filter (stnum)
-
km{number}
-
Mile marker filter (km)
-
municipality{string}
-
Municipality name filter (munn)
-
municipalityId{string}
-
Municipality code filter (munc)
-
name{string}
-
Name general filter (locn)
-
num{number}
-
Maximum number of results (num)
-
numCand{string}
-
Number of candidates per page (numcand)
-
poicat{string}
-
POIs categories filter (poicat)
-
poiId{string}
-
POI code filter (poic)
-
poiName{string}
-
POI name filter (poiname)
-
posCand{string}
-
First candidate position, begining with 0 (poscand)
-
postalCode{string}
-
Postal code filter (pcode)
-
region{string}
-
Region name filter (regn)
-
regionId{string}
-
Region code filter (regc)
-
roadId{string}
-
Road code filter (rdc)
-
roadName{string}
-
Road name filter (rdn)
-
street{string}
-
Street name filter (stn)
-
street2{string}
-
Secondary street name filter to search cross-streets (istn)
-
street2Id{string}
-
Secondary street code filter to search cross-streets (istc)
-
streetId{string}
-
Street code filter (stc)
-
subOrRegion{string}
-
Region and Subregion name filter (rsn)
-
subregion{string}
-
Subregion name filter (subregn)
-
subregionId{string}
-
Subregion code filter (subregc)
Methods
-
clear()
-
Use null to all properties.
-
geocode(callbackFn, callbackErrorFn)
-
AJAX request
Name Type Description callbackFn
function callbackErrorFn
function | undefined optional -
getClass(){string}
-
Returns the object type.
-
getResponse(){Object}
-
Returns the response once the 'geocode' function finished
Returns:
response
-
setAsync(async)
-
Change the geocoding request synchronously.
Name Type Description async
boolean -
setSearch(options)
-
Name Type Description options
cercaliax.service.Geocoding