Class: Proximity

Members

city{string}

City name filter (ctn)

cityId{string}

City code filter (ctc)

country{string}

Country name filter (ctryn)

countryId{string}

Country code filter (ctryc)

fullSearch{string}

Solve all the candidate params (fullsearch)

housenumber{number}

Housenumber filter (stnum)

infoxml{boolean}

inverse{boolean}

km{number}

Road milestone filter (km)

mos{Array.<string>}

municipality{string}

Municipality name filter (munn)

municipalityId{string}

Municipality code filter (munc)

name{string}

Search by name, general search with no filters (locn)

num{number}

Maximum number of candidates. Maxim server value 99 (num)

numCand{string}

Maximum number of candidates per page (numcand)

posCand{string}

First candidate position for every page, starting from 0 (poscand)

postalCode{string}

Postal code filter, requires country code (pcode)

rad{number}

region{string}

Region name filter (regn)

regionId{string}

Region code filter (regc)

roadId{string}

Road cod filter (rdc)

roadName{string}

Road name filter (rdn)

rqge{string}

rqpoicats{Array.<string>}

srs{string}

street{string}

Street name filter (stn)

street2{string}

Second street name filter, for street intersection seach (istn)

street2Id{string}

Second street code filter, for street intersection seach (istc)

streetId{string}

Street code filter (stc)

subOrRegion{string}

Region / subregion name filter (rsn)

subregion{string}

Subregion name filter (subregn)

subregionId{string}

Subregion code filter (subregc)

weight{string}

wkt{string}

x{number}

y{number}

Methods

clear()

cercalia.service.proximity.js, line 271

Set null all the properties.

getClass(){string}

cercalia.service.proximity.js, line 447

Returns the object type.

getResponse(){Object}

cercalia.service.proximity.js, line 363

Returns response to the query with function 'proximity'

Returns:

response

proximity(callbackFn)

cercalia.service.proximity.js, line 371

Execute AJAX request

Name	Type	Description
callbackFn	function

setSearch(options)

cercalia.service.proximity.js, line 312

Name	Type	Description
options	cercaliax.service.Proximity