v5 v4

Class: Geocoding

cercalia.service.Geocoding

new cercalia.service.Geocoding(options)

temp/jsdocinputdirs/cercalia.service.geocoding.js, line 7

Geocoding service constructor

Name Type Description
options

Opciones Geocoding

Name Type Description
name string | undefined optional

Name filter (locn).
countryId string | undefined optional

Country code filter (ctryc).
country string | undefined optional

Country name filter (ctryn).
regionId string | undefined optional

Region code filter (regc).
region string | undefined optional

Region name filter (regn).
subregionId string | undefined optional

Subregion code filter (subregc).
subregion string | undefined optional

Subregion name filter (subregn).
subOrRegion string | undefined optional

Region & Subregion name filter (rsn).
municipalityId string | undefined optional

Municipality code filter (munc).
municipality string | undefined optional

Municipality name filter (munn).
cityId string | undefined optional

City code filter (ctc).
city string | undefined optional

City name filter (ctn).
postalCode string | undefined optional

Postal Code filter, requires country code (pcode).
address string | undefined optional

Address filter, including house number.
streetId string | undefined optional

Street code filter.
street string | undefined optional

Street name filter.
street2 string | undefined optional

Second street name filter, for intersection search between main street and second street.
street2Id string | undefined optional

Second street code filter, for intersection search between main street and second street.
housenumber number | undefined optional

House number filter.
roadId string | undefined optional

Road code filter.
roadName string | undefined optional

Road name filter.
km number | undefined optional

Mile marker filter (only for roads).
fullSearch string | undefined optional

Resolves all the candidate parameters (fullsearch).
numCand number | undefined optional

Maximum number of candidates per page (numcand).
posCand string | undefined optional

First candidate position, starting from 0 (poscand).
num number | undefined optional

Maximum number of candidates (num).
poicat string | undefined optional

List of Points of Interest - POIs (poicat).
poiId string | undefined optional

POI code filter (poic).
poiName string | undefined optional

POI name filter (poiname).

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()

temp/jsdocinputdirs/cercalia.service.geocoding.js, line 230

Use null to all properties.

geocode(callbackFn, callbackErrorFn)

temp/jsdocinputdirs/cercalia.service.geocoding.js, line 316

AJAX request

Name Type Description
callbackFn function
callbackErrorFn function | undefined optional

getClass(){string}

temp/jsdocinputdirs/cercalia.service.geocoding.js, line 390

Returns the object type.

getResponse(){Object}

temp/jsdocinputdirs/cercalia.service.geocoding.js, line 307

Returns the response once the 'geocode' function finished

Returns:
response

setAsync(async)

temp/jsdocinputdirs/cercalia.service.geocoding.js, line 223

Change the geocoding request synchronously.

Name Type Description
async boolean

setSearch(options)

temp/jsdocinputdirs/cercalia.service.geocoding.js, line 267
Name Type Description
options cercaliax.service.Geocoding