gem.routesAndNavigation. RoutesRequest

new RoutesRequest()

Routes Request class

Extends

Methods

addWaypoint(coordinates)

Add a waypoint, by coordinates, for route calculation.

Parameters:
NameTypeDescription
coordinatesgem.core.Coordinates

addWaypointFromLandmark(landmark)

Add a waypoint, by landmark, for route calculation.

Parameters:
NameTypeDescription
landmarkgem.core.Landmark

calculateRoute(callbackfunction)

Parameters:
NameTypeDescription
callbackfunction*

delete()

calls emscripten object destructor

Inherited From

get(nId) → {gem.routesAndNavigation.Route}

Parameters:
NameTypeDescription
nIdnumber
Overrides
Returns:
  • Route Object
Type: 
gem.routesAndNavigation.Route

getRawPointer() → {object}

Returns emscripten object

Returns:
Type: 
object

isDeleted() → {boolean}

Check if emscripten object has been deleted

Inherited From
Returns:
Type: 
boolean

push_back(object)

Parameters:
NameTypeDescription
objectobject
Inherited From

setAvoidBikingHillFactor(fValue)

Set avoid biking hill factor

Parameters:
NameTypeDescription
fValuenumber

0.0 - no avoidance, 1.0 - full avoidance

setAvoidFerries(bValue)

Set the avoid ferries flag.

Parameters:
NameTypeDescription
bValueboolean

setAvoidMotorways(bValue)

Set the avoid motorways flag. Default is false

Parameters:
NameTypeDescription
bValueboolean

setAvoidTollRoads(bValue)

Set the avoid toll roads flag.Default is false

Parameters:
NameTypeDescription
bValueboolean

setAvoidTraffic(bValue)

Enable/disable traffic information usage for route calculation.Default is false.

Parameters:
NameTypeDescription
bValueboolean

setAvoidUnpavedRoads(bValue)

Sets the avoid unpaved roads flag.

Parameters:
NameTypeDescription
bValueboolean

setBikeProfile(bikeProfile)

Set Bike Profile

Parameters:
NameTypeDescription
bikeProfilegem.routesAndNavigation.EBikeProfile

Set the bike profile to be used for the route calculation.

setBikeProfileWithElectricType(bikeProfile, electricBikeProfile)

Set Bike Profile and Electric bike profile

Parameters:
NameTypeDescription
bikeProfilegem.routesAndNavigation.EBikeProfile
electricBikeProfilegem.routesAndNavigation.ElectricBikeProfile

setBuildTerrainProfile(bValue)

Enable terrain profile build

Parameters:
NameTypeDescription
bValueboolean

setEVProfile(evProfile)

Parameters:
NameTypeDescription
evProfilegem.routesAndNavigation.EVProfile

setPathAlgorithm(pathAlgorithm)

Sets the path calculation algorithm

Parameters:
NameTypeDescription
pathAlgorithmgem.routesAndNavigation.ERoutePathAlgorithm

setResultDetails(resultDetails)

Set result details

Parameters:
NameTypeDescription
resultDetailsgem.routesAndNavigation.ERouteResultDetails

setRouteRanges(routeranges)

Set route ranges list.A non empty range list will generate an isocost range route result

Parameters:
NameTypeDescription
routerangesobject
Properties
NameTypeAttributesDescription
rangelistArray<optional>

array of range intervals. ranges units depends on route type(set by setRouteType): gem.routesAndNavigation.ERouteType.ERT_Fastest - seconds, gem.routesAndNavigation.ERouteType.ERT_Shortest - meters , gem.routesAndNavigation.ERouteType.ERT_Economic - watt-hour( Wh)

qualitycallbackMarker<optional>

range result quality must a valid integer in 0 - 100 range, 0 = lowest quality, 100 = highest quality

setRouteType(routeType)

Set the route type.

Parameters:
NameTypeDescription
routeTypegem.routesAndNavigation.ERouteType

setTransportMode(transportMode)

Sets the transport mode.

Parameters:
NameTypeDescription
transportModegem.routesAndNavigation.ERouteTransportMode

size() → {number}

Returns:
  • the number of calculated routes.
Type: 
number