Version:

Class: Distance

cercalia.service.Distance


Class designed for route calculation.

new cercalia.service.Distance(opt_options)

src/cercalia/service/distance.js, line 20
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. Required.
destination cercalia.LonLat

Destination. If not defined, then use setDestination to initialize variable; Required.
origin cercalia.LonLat

Origin. If not defined, then use setOrigin to initialize variable; Required.
steps

Sequential stop list. Required.
weight string

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

Extends

Methods

calculate(callbackFn)

src/cercalia/service/distance.js, line 154

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} inherited

src/cercalia/object.js, line 41
Returns:
Get Class name of object

getDestination(){cercalia.LonLat|null}

src/cercalia/service/distance.js, line 94
Returns:
Returns the destination assigned previously

getId(){string} inherited

src/cercalia/object.js, line 33
Returns:
Unique Id.

getOrigin(){cercalia.LonLat|null}

src/cercalia/service/distance.js, line 77
Returns:
Returns the origin assigned previously

getSteps(){}

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

getWeight(){string}

src/cercalia/service/distance.js, line 127

Values = [line|time|distance|money]

Returns:
weight

isCalculateGeometry(){boolean}

src/cercalia/service/distance.js, line 144

Returns if calculate geometry function it's on or off

Returns:
calculateGeometry true or false. If calculate geometry option is enabled.

setCalculateGeometry(calculateGeometry)

src/cercalia/service/distance.js, line 135
Name Type Description
calculateGeometry boolean

True if geometry will be returned after calculation..

setDestination(lonLat)

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

Destination

setOrigin(lonLat)

src/cercalia/service/distance.js, line 68
Name Type Description
lonLat cercalia.LonLat

Assign the origin of distance calculation

setSteps(steps)

src/cercalia/service/distance.js, line 102
Name Type Description
steps

Array with steps

setWeight(weight)

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

Weight. Available values line|time|distance|money