Class: Geocoding

cercalia.service.Geocoding


new cercalia.service.Geocoding(opt_options)

src/cercalia/service/geocoding.js, line 15

Geocoding service constructor

Name Type Description
options

Geocoding control options.

Name Type Description
name string | undefined

Name filter (locn).

countryId string | undefined

Country code filter (ctryc).

country string | undefined

Country name filter (ctryn).

regionId string | undefined

Region code filter (regc).

region string | undefined

Region name filter (regn).

subregionId string | undefined

Subregion code filter (subregc).

subregion string | undefined

Subregion name filter (subregn).

subOrRegion string | undefined

Region & Subregion name filter (rsn).

municipalityId string | undefined

Municipality code filter (munc).

municipality string | undefined

Municipality name filter (munn).

cityId string | undefined

City code filter (ctc).

city string | undefined

City name filter (ctn).

postalCode string | undefined

Postal Code filter, requires country code (pcode).

address string | undefined

Address filter, including house number.

streetId string | undefined

Street code filter.

street string | undefined

Street name filter.

street2 string | undefined

Second street name filter, for intersection search between main street and second street.

street2Id string | undefined

Second street code filter, for intersection search between main street and second street.

housenumber number | undefined

House number filter.

roadId string | undefined

Road code filter.

roadName string | undefined

Road name filter.

km number | undefined

Mile marker filter (only for roads).

fullSearch string | undefined

Resolves all the candidate parameters (fullsearch).

numCand number | undefined

Maximum number of candidates per page (numcand).

posCand string | undefined

First candidate position, starting from 0 (poscand).

num number | undefined

Maximum number of candidates (num).

poicat string | undefined

List of Points of Interest - POIs (poicat).

poiId string | undefined

POI code filter (poic).

poiName string | undefined

POI name filter (poiname).

Extends

Methods

clear()

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

Clear search.

geocode(callbackFn)

src/cercalia/service/geocoding.js, line 264

AJAX request

Name Type Description
callbackFn function

Callback Function to parse server data.

getClass(){string} inherited

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

getId(){string} inherited

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

getResponse(){Object}

src/cercalia/service/geocoding.js, line 255

Returns the response once the 'geocode' function finished

Returns:
response

setSearch(options)

src/cercalia/service/geocoding.js, line 207
Name Type Description
options

Geocoding search options.

Name Type Description
name string | undefined

Name filter (locn).

countryId string | undefined

Country code filter (ctryc).

country string | undefined

Country name filter (ctryn).

regionId string | undefined

Region code filter (regc).

region string | undefined

Region name filter (regn).

subregionId string | undefined

Subregion code filter (subregc).

subregion string | undefined

Subregion name filter (subregn).

subOrRegion string | undefined

Region & Subregion name filter (rsn).

municipalityId string | undefined

Municipality code filter (munc).

municipality string | undefined

Municipality name filter (munn).

cityId string | undefined

City code filter (ctc).

city string | undefined

City name filter (ctn).

postalCode string | undefined

Postal Code filter, requires country code (pcode).

address string | undefined

Address filter, including house number.

streetId string | undefined

Street code filter.

street string | undefined

Street name filter.

street2 string | undefined

Second street name filter, for intersection search between main street and second street.

street2Id string | undefined

Second street code filter, for intersection search between main street and second street.

housenumber number | undefined

House number filter.

roadId string | undefined

Road code filter.

roadName string | undefined

Road name filter.

km number | undefined

Mile marker filter (only for roads).

fullSearch string | undefined

Resolves all the candidate parameters (fullsearch).

numCand number | undefined

Maximum number of candidates per page (numcand).

posCand string | undefined

First candidate position, starting from 0 (poscand).

num number | undefined

Maximum number of candidates (num).

poicat string | undefined

List of Points of Interest - POIs (poicat).

poiId string | undefined

POI code filter (poic).

poiName string | undefined

POI name filter (poiname).