Module: cercaliagl/service/Proximity


Classes

Proximity

Type Definitions

ProximityOptions{Object}

Properties:
Name Type Argument Description
name string <optional>

Name filter.
countryId string <optional>

Country code filter.
country string <optional>

Country name filter.
regionId string <optional>

Region code filter.
region string <optional>

Region name filter.
subregionId string <optional>

Subregion code filter.
subregion string <optional>

Subregion name filter.
subOrRegion string <optional>

Region & Subregion name filter.
municipalityId string <optional>

Municipality code filter.
municipality string <optional>

Municipality name filter.
cityId string <optional>

City code filter.
city string <optional>

City name filter.
postalCode string <optional>

Postal Code filter, requires country code.
streetId string <optional>

Street code filter.
street string <optional>

Street name filter.
street2 string <optional>

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

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

House number filter.
roadName string <optional>

Road name filter.
roadId string <optional>

Road code filter.
km number <optional>

Mile marker filter (only for roads).
fullSearch string <optional>

Resolves all the candidate parameters.
numCand string <optional>

Maximum number of candidates per page.
posCand number <optional>

First candidate position, starting from 0.
num number <optional>

Maximum number of candidates.
wkt string <optional>

Reference geometry.
srs string <optional>

Coordinates reference system.
x number <optional>

X coordinate central reference.
y number <optional>

Y coordinate central reference.
rqge string <optional>

Geo-entity level. Available values adr|st|ct|mun|subreg|reg|ctry.
rqpoicats Array.<string> <optional>

Array of POIs categories.
infoxml boolean <optional>

If a numeric value other than 0 is specified, it returns XML information associated with the Point of Interest.
weight number <optional>

Proximity with real route distance. Values: time, distance, money.
inverse boolean <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> <optional>

List of coordinates (type MO).
rad number <optional>

Maximum search radius (direct distance).