v5 v4

Class: Proximity

cercalia.service.Proximity

new cercalia.service.Proximity(options, callbackFn)

temp/jsdocinputdirs/cercalia.service.proximity.js, line 8

Proximity service constructor

Name Type Description
options

Proximity options

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).
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).
wkt string | undefined optional

Reference geometry.
srs string | undefined optional

Coordinates reference system.
x number | undefined optional

X coordinate central reference.
y number | undefined optional

Y coordinate central reference.
rqge string | undefined optional

Geo-entity level (adr,st,ct,mun,subreg,reg,ctry).
rqpoicats Array.<string> | undefined optional

Array of POIs categories.
infoxml string | undefined optional

If a numeric value other than 0 is specified, it returns XML information associated with the Point of Interest.
weight string | undefined optional

Optional. Proximity with real route distance. Values: time, distance, money.
inverse boolean | undefined optional

Optional. Can be true or false. With a false value, the distances are calculated from the reference to the target. With a true value, the distances are calculated from the references to the targets. The default is false.
mos Array.<string> | undefined optional

List of coordinates (type MO).
rad number | undefined optional

Maximum search radius (direct distance).
callbackFn function

Callback function

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

temp/jsdocinputdirs/cercalia.service.proximity.js, line 271

Set null all the properties.

getClass(){string}

temp/jsdocinputdirs/cercalia.service.proximity.js, line 447

Returns the object type.

getResponse(){Object}

temp/jsdocinputdirs/cercalia.service.proximity.js, line 363

Returns response to the query with function 'proximity'

Returns:
response

proximity(callbackFn)

temp/jsdocinputdirs/cercalia.service.proximity.js, line 371

Execute AJAX request

Name Type Description
callbackFn function

setSearch(options)

temp/jsdocinputdirs/cercalia.service.proximity.js, line 312
Name Type Description
options cercaliax.service.Proximity