Class: Distance

cercaliagl.service/Distance


Service class to calculate distance between two or more points.
It can calculate distance by weight. Weight available are: `

new Distance(options)

service/Distance.js, line 29
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.
origin module:cercaliagl/LonLat~LonLat

Origin. If not defined, then use setOrigin to initialize variable;
destination module:cercaliagl/LonLat~LonLat

Destination. If not defined, then use setDestination to initialize variable;
steps Array.<module:cercaliagl/LonLat~LonLat>

Sequential stop list.
weight string | undefined

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

Extends

  • module:cercaliagl/service/Service~Service

Methods

module:cercaliagl/service/Distance~Distance.calculateDistanceOnArea(area){number}

service/Distance.js, line 281
Name Type Description
area module:@turf/helpers~Feature | module:@turf/helpers~FeatureCollection.<any> | module:@turf/helpers~Geometry

input GeoJSON feature(s)
Returns:
Distance in quare meters

module:cercaliagl/service/Distance~Distance.calculateDistanceOnLine(geojson, units){number}

service/Distance.js, line 269
Name Type Description
geojson GeoJSON.Feature.<(GeoJSON.LineString|GeoJSON.MultiLineString)>

GeoJSON to measure
units module:@turf/helpers~Units (defaults to kilometers)

Kilometers || miles || radians || degrees. Kilometers by default
Returns:
Distance in the specified units

calculate(callbackFn)

service/Distance.js, line 169

Distance calculation with the assigned parameters, and returns the data to the callback function which is called once server returns response.

Name Type Description
callbackFn function

Callback function

getDestination(){module:cercaliagl/LonLat~LonLat|null}

service/Distance.js, line 106

Returns the destination.

Returns:
Destination point

getOrigin(){module:cercaliagl/LonLat~LonLat|null}

service/Distance.js, line 87

Obtain origin.

Returns:
Returns the origin assigned previously

getSteps(){Array.<module:cercaliagl/LonLat~LonLat>}

service/Distance.js, line 124

Get steps (or waypoints)

Returns:
Steps

getWeight(){string}

service/Distance.js, line 142

Get weight. Available values line|time|distance|money

Returns:
weight

isCalculateGeometry(){boolean}

service/Distance.js, line 159

Returns if calculate geometry functionality is active or inactive

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

setCalculateGeometry(calculateGeometry)

service/Distance.js, line 150
Name Type Description
calculateGeometry boolean

true if geometry will be returned after calculation..

setDestination(lonLat)

service/Distance.js, line 96

Set destination point.

Name Type Description
lonLat module:cercaliagl/LonLat~LonLat

Destination point

setOrigin(lonLat)

service/Distance.js, line 77

Set origin point.

Name Type Description
lonLat module:cercaliagl/LonLat~LonLat

Origin point

setSteps(steps)

service/Distance.js, line 115

Set steps (or waypoints)

Name Type Description
steps Array.<module:cercaliagl/LonLat~LonLat>

Array with steps

setWeight(weight)

service/Distance.js, line 133

Set weight to calculate distance

Name Type Description
weight string

Weight. Available values line|time|distance|money