Class: Isochrone

cercalia.service.Isochrone

new cercalia.service.Isochrone(options)

Isochrone service constructor

Name Type Description
options

Isochrone request options

Name Type Description
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 and Subregion name filter (rsn)

municipalityId string | undefined optional

Municipality code filter (munc)

municipality string | undefined optional

Municipality name filter (munn)

cityId string | undefined optional

Town code filter (ctc)

city string | undefined optional

Town name filter (ctn)

postalCode string | undefined optional

Postal code filter (pcode)

streetId string | undefined optional

Street code filter (stc)

street string | undefined optional

Street name filter (stn)

housenumber number | undefined optional

House number filter (stnum)

address string | undefined optional

Street name filter with house number

position cercalia.LonLat | undefined optional

Position of center to calculate isochrone request.

weight string | undefined optional

Type of search value. Possible values distance or time. Default value distance

inverse boolean | undefined optional

If false, the calculation is from the center to outside. If true, the calculation is from outside to the center. Default value false.

method string | undefined optional

Calculation method. Por defecto: convexhull or concavehull. Default value convexhull.

isolevels number | string

Value, or incremental values list used for isochrone calculation (meters or miliseconds). Ex: 10000, 5000,10000,20000.

Members

address{string} {undefined}

Street name filter with house number

city{string} {undefined}

Town name filter (ctn)

cityId{string} {undefined}

Town code filter (ctc)

country{string} {undefined}

Country name filter (ctryn)

countryId{string} {undefined}

Country code filter (ctryc)

housenumber{number} {undefined}

House number filter (stnum)

inverse{boolean} {undefined}

If false, the calculation is from the center to outside. If true, the calculation is from outside to the center. Default value false.

isolevels{number} {string}

Value, or incremental values list used for isochrone calculation (meters or miliseconds). Ex: 10000, 5000,10000,20000.

method{string} {undefined}

Calculation method. Por defecto: convexhull or concavehull. Default value convexhull.

municipality{string} {undefined}

Municipality name filter (munn)

municipalityId{string} {undefined}

Municipality code filter (munc)

position{cercalia.LonLat} {undefined}

Position of center to calculate isochrone request.

postalCode{string} {undefined}

Postal code filter (pcode)

region{string} {undefined}

Region name filter (regn)

regionId{string} {undefined}

Region code filter (regc)

street{string} {undefined}

Street name filter (stn)

streetId{string} {undefined}

Street code filter (stc)

subOrRegion{string} {undefined}

Region and Subregion name filter (rsn)

subregion{string} {undefined}

Subregion name filter (subregn)

subregionId{string} {undefined}

Subregion code filter (subregc)

weight{string} {undefined}

Type of search value. Possible values distance or time. Default value distance

Methods

calculate(callbackFn, callbackErrorFn)

Do isochrone request.

Name Type Description
callbackFn function
callbackErrorFn function | undefined optional

Use null to all properties.

Returns the object type.

Returns the response once the 'isochrone' function finished

Returns:
response
Name Type Description
options cercaliax.service.Geocoding