v5 v4

Class: Distance

cercalia.service.Distance

Class designed for route calculation.

new cercalia.service.Distance(options)

cercalia.service.distance.js, line 9
Name Type Description
options cercaliax.service.DistanceOptions

Params and options for distance calculation

Methods

calculate(callbackFn)

cercalia.service.distance.js, line 153

Distance calculation with the assigned parameters, and returns the data to the callback function specified by parameter by the user.

Name Type Description
callbackFn function

callback funcion

getClass(){string}

cercalia.service.distance.js, line 351

Returns the object type.

getDestination(){cercalia.LonLat}

cercalia.service.distance.js, line 96
Returns:
Returns the destination assigned previously

getOrigin(){cercalia.LonLat}

cercalia.service.distance.js, line 78
Returns:
Returns the origin assigned previously

getSteps(){Array.<cercalia.LonLat>}

cercalia.service.distance.js, line 110
Returns:
destination

getWeight(){string}

cercalia.service.distance.js, line 126

Values = [line|time|distance|money]

Returns:
weight

isCalculateGeometry(){boolean}

cercalia.service.distance.js, line 142

Returns if calculate geometry function it's on or off

Returns:
calculateGeometry

setCalculateGeometry(calculateGeometry)

cercalia.service.distance.js, line 134
Name Type Description
calculateGeometry boolean

setDestination(lonLat)

cercalia.service.distance.js, line 85
Name Type Description
lonLat cercalia.LonLat

Destination

setOrigin(lonLat)

cercalia.service.distance.js, line 67
Name Type Description
lonLat cercalia.LonLat

Assign the origin of distance calculation

setSteps(steps)

cercalia.service.distance.js, line 103
Name Type Description
steps Array.<cercalia.LonLat>

Array with steps

setWeight(weight)

cercalia.service.distance.js, line 118
Name Type Description
weight string