v5 v4

Class: Distance

cercalia.service.Distance

Class designed for route calculation.

new cercalia.service.Distance(options)

temp/jsdocinputdirs/cercalia.service.distance.js, line 9
Name Type Description
options

Params and options for distance calculation

Name Type Description
calculateGeometry Boolean

Specify if you need to obtain the shape geometry when calculating the distance. For weight=='line' this option is not avaliable.
destination cercalia.LonLat

Destination.
origin cercalia.LonLat

Origin.
steps Array.<cercalia.LonLat>

Sequential stop list.
weight string

Distance calculation considering weight/type (line|time|distance|money|undefined). Default value line.

Methods

calculate(callbackFn)

temp/jsdocinputdirs/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}

temp/jsdocinputdirs/cercalia.service.distance.js, line 351

Returns the object type.

getDestination(){cercalia.LonLat}

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

getOrigin(){cercalia.LonLat}

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

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

temp/jsdocinputdirs/cercalia.service.distance.js, line 110
Returns:
destination

getWeight(){string}

temp/jsdocinputdirs/cercalia.service.distance.js, line 126

Values = [line|time|distance|money]

Returns:
weight

isCalculateGeometry(){boolean}

temp/jsdocinputdirs/cercalia.service.distance.js, line 142

Returns if calculate geometry function it's on or off

Returns:
calculateGeometry

setCalculateGeometry(calculateGeometry)

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

setDestination(lonLat)

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

Destination

setOrigin(lonLat)

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

Assign the origin of distance calculation

setSteps(steps)

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

Array with steps

setWeight(weight)

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