new cercalia.service.Proximity(opt_options)
Proximity service constructor
Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Proximity options
|
Extends
Methods
-
clear()
src/cercalia/service/proximity.js, line 257 -
Set null all the properties.
-
Returns:
Get Class name of object
-
Returns:
Unique Id.
-
getResponse(){Object}
src/cercalia/service/proximity.js, line 351 -
Returns response to the query with function 'proximity'
Returns:
response
-
proximity(callbackFn)
src/cercalia/service/proximity.js, line 360 -
Execute AJAX request
Name Type Description callbackFn
function Callback Function
-
setSearch(options)
src/cercalia/service/proximity.js, line 299 -
Name Type Description options
Proximity 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).
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).
wkt
string | undefined Reference geometry.
srs
string | undefined Coordinates reference system.
x
number | undefined X coordinate central reference.
y
number | undefined Y coordinate central reference.
rqge
string | undefined Geo-entity level (adr,st,ct,mun,subreg,reg,ctry).
rqpoicats
Array.<string> | undefined Array of POIs categories.
infoxml
boolean | undefined If a numeric value other than 0 is specified, it returns XML information associated with the Point of Interest.
weight
string | undefined Optional. Proximity with real route distance. Values: time, distance, money.
inverse
boolean | undefined 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 List of coordinates (type MO).
rad
number | undefined Maximum search radius (direct distance).