Maps Web SDK

Class Routing

Category Services

It allows to calculate a route between two locations using the TomTom's Routing API;

Parameters can be passed to the constructor or provided via convenient methods that can be chained until the method go performs the actual call.

The call is asynchronous therefore the user have two options for receive the response:

  • Passing a callback function.
  • Use the Promise returned by the go method to handle the response.

The SDK provides a Promise polyfill for browsers (IE<9) without native ECMAScript 6 support.

The types used in routing service

point - Latitude, longitude pair (in EPSG4326 projection), with the following constraints: Latitude values must be in the range -90..+90 inclusive. Longitude values must be in the range -180..+180 inclusive. Example: 52.37245,4.89406

circle - A circle with a center point and a radius (in meters). The radius must be a positive integer with the maximum value of 20050000. Note that larger integer values will not be rejected but lowered to the maximum value. Example: circle(52.37245,4.89406,10000)

location - A point or a circle. Example: 52.37245,4.89406 circle(52.37245,4.89406,10000)

dateTime - A date and time specified in RFC-3339 format with an optional time zone offset. Example: 1996-12-19T16:39:57 1996-12-19T16:39:57-08:00

Constructor

Routing([options])

Parameters
Name Description Required Type/Values Default
options Options to be passed to the routing call, or Array of such options objects to perform batch request. No Object | Array None
key The API key to be used. No String global API key
locations Locations through which the route is calculated No String None
maxAlternatives Number of desired alternative routes to be calculated No String None
routeType The type of route requested. No String None
traffic consider all available traffic information during routing No String None
avoid Specifies something that the route calculation should try to avoid when determining the route. No String None
instructionsType If specified, guidance instructions will be returned (if available) No String None
language The language parameter determines the language of the guidance messages No String None
departAt The date and time of departure from the origin point No String None
arriveAt The date and time of arrival at the destination point No String None
computeBestOrder Re-order the route waypoints to reduce the route length No String None
routeRepresentation Specifies the representation of the set of routes provided as response No String None
travelMode The mode of travel for the requested route No String None
hilliness Degree of hilliness for thrilling route No String None
windingness Level of turns for thrilling route No String None
protocol Protocol's type, one of "http" or "https". No Boolean None
Example
tomtom.routing()
  .locations('52.3,4.8:52.37,4.87')
  .go()
  .then(function(routeGeoJson) {
    console.log(routeGeoJson);
  });

Methods

accelerationEfficiency([accelerationEfficiency]): Number Chainable

A setter and getter for 'accelerationEfficiency' attribute. Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates (i.e. KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed is obtained by converting consumed fuel to chemical energy using fuelEnergyDensityInMJoulesPerLiter.

Parameters
Name Description Required Type/Values Default
accelerationEfficiency No Number None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

arriveAt([arriveAt]): String Chainable

A setter and getter for 'arriveAt' attribute. The date and time of arrival at the destination point. It must be specified as a dateTime. When a time zone offset is not specified it will be assumed to be that of the destination point. The arriveAt value must be in the future. The arriveAt parameter cannot be used in conjunction with departAt.

Parameters
Name Description Required Type/Values Default
arriveAt The properly formatted date with time value. Date cannot be in the past. No String None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or language if argument is omitted.

auxiliaryPowerInkW([auxiliaryPowerInkW]): Number Chainable

A setter and getter for 'auxiliaryPowerInkW' attribute. Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW). It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.

Parameters
Name Description Required Type/Values Default
auxiliaryPowerInkW No Number None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

auxiliaryPowerInLitersPerHour([auxiliaryPowerInLitersPerHour]): Number Chainable

A setter and getter for 'auxiliaryPowerInLitersPerHour' attribute. Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour. It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.

Parameters
Name Description Required Type/Values Default
auxiliaryPowerInLitersPerHour No Number None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

avoid([avoid]): Array Chainable

A setter and getter for 'avoid' attribute. Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times. Possible values:

  • tollRoads avoids toll roads.
  • motorways avoids motorways.
  • ferries avoids ferries.
  • unpavedRoads avoids unpaved roads.
  • carpools avoids routes that require use of carpool (HOV/ High Occupancy Vehicle) lanes.
  • alreadyUsedRoads avoids using the same road multiple times.

Most useful in conjunction with routeType=thrilling.

Parameters
Name Description Required Type/Values Default
avoid Specifies something that the route calculation should try to avoid when determining the route No Array | String None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or street number value if argument is omitted.

computeBestOrder([computeBestOrder]): String Chainable

A setter and getter for 'computeBestOrder' attribute. Allows to reorder the route waypoints to reduce the route length. Yields best results when used in conjunction with routeType shortest. Possible values:

  • true (compute a better order, if possible; not allowed to be used in conjunction with maxAlternatives value greater than 0; not allowed to be used in conjunction with circle waypoints). The response will include the optimized waypoint indices. This feature can be used with a maximum of 20 route waypoints.
  • false (use the locations in the given order). Not allowed to be used in conjunction with routeRepresentation none.

Parameters
Name Description Required Type/Values Default
computeBestOrder Flag to reorder the route waypoints to reduce the route length No String None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or language if argument is omitted.

computeTravelTimeFor([computeTravelTimeFor]): String Chainable

A setter and getter for 'computeTravelTimeFor' attribute. Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time. Possible values:

  • none - do not compute additional travel times,
  • all - compute travel times for all types of traffic information. Specifying all results in the fields noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds and liveTrafficIncidentsTravelTimeInSeconds being included in the summaries in the route response.

Parameters
Name Description Required Type/Values Default
computeTravelTimeFor Setting all provides additional information regards travel times. No String None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

constantSpeedConsumptionInkWhPerHundredkm([constantSpeedConsumptionInkWhPerHundredkm]): Array Chainable

A setter and getter for 'constantSpeedConsumptionInkWhPerHundredkm' attribute. Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:

  • by linear interpolation, if the given speed lies in between two speeds in the list
  • by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list

The list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed. If it only contains a single point, then the consumption rate of that point is used without further processing. Consumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates. Similarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed. The minimum and maximum values described here refer to the valid range for the consumption values (expressed in kWh/100km).

Parameters
Name Description Required Type/Values Default
constantSpeedConsumptionInkWhPerHundredkm Colon-delimited list of ElectricConstantSpeedConsumptionPairs, e.g. array of such pairs "60,7". No Array None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

constantSpeedConsumptionInLitersPerHundredkm([constantSpeedConsumptionInLitersPerHundredkm]): Array Chainable

A setter and getter for 'constantSpeedConsumptionInLitersPerHundredkm' attribute. Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:

  • by linear interpolation, if the given speed lies in between two speeds in the list
  • by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list.

The list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed. If it only contains a single point, then the consumption rate of that point is used without further processing. Consumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates. Similarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed. The minimum and maximum values described here refer to the valid range for the consumption values (expressed in l/100km).

Parameters
Name Description Required Type/Values Default
constantSpeedConsumptionInLitersPerHundredkm Colon-delimited list of CombustionConstantSpeedConsumptionPairs, e.g. array of such pairs "60,7". No Array None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

currentChargeInkWh([currentChargeInkWh]): Number Chainable

A setter and getter for 'currentChargeInkWh' attribute. Specifies the current electric energy supply in kilowatt hours (kWh).

Parameters
Name Description Required Type/Values Default
currentChargeInkWh No Number None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

currentFuelInLiters([currentFuelInLiters]): Number Chainable

A setter and getter for 'currentFuelInLiters' attribute. Specifies the current supply of fuel in liters.

Parameters
Name Description Required Type/Values Default
currentFuelInLiters No Number None
Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

decelerationEfficiency([decelerationEfficiency]): Number Chainable

A setter and getter for 'decelerationEfficiency' attribute. Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates (i.e. ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved is obtained by converting saved (not consumed) fuel to energy using fuelEnergyDensityInMJoulesPerLiter.

Parameters
Name Description Required Type/Values Default
decelerationEfficiency No Number None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

departAt([departAt]): String Chainable

A setter and getter for 'departAt' attribute. The date and time of departure from the origin point. Departure times apart from now must be specified as a dateTime. When a time zone offset is not specified, it will be assumed to be that of the origin point. The departAt value must be in the future. The departAt parameter cannot be used in conjunction with arriveAt.

Parameters
Name Description Required Type/Values Default
departAt The properly formatted date with time or 'now' value. Date cannot be in the past. No String None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or language if argument is omitted.

downhillEfficiency([downhillEfficiency]): Number Chainable

A setter and getter for 'downhillEfficiency' attribute. Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation (i.e. ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved is obtained by converting saved (not consumed) fuel to energy using fuelEnergyDensityInMJoulesPerLiter.

Parameters
Name Description Required Type/Values Default
downhillEfficiency No Number None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

fuelEnergyDensityInMJoulesPerLiter([fuelEnergyDensityInMJoulesPerLiter]): Number Chainable

A setter and getter for 'fuelEnergyDensityInMJoulesPerLiter' attribute. Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ). It is used in conjunction with the *Efficiency parameters for conversions between saved or consumed energy and fuel. For example, energy density is 34.2 MJ/l for gasoline, and 35.8 MJ/l for Diesel fuel.

Parameters
Name Description Required Type/Values Default
fuelEnergyDensityInMJoulesPerLiter No Number None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

hilliness([hilliness]): String Chainable

A setter and getter for 'hilliness' attribute. Degree of hilliness for thrilling route. Possible values: low, normal, high This parameter can only be used in conjunction with routeType thrilling.

Parameters
Name Description Required Type/Values Default
hilliness The level of hilliness on a thrilling route. No String None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or language if argument is omitted.

instructionsType([instructionsType]): String Chainable

A setter and getter for 'instructionsType' attribute. If specified, guidance instructions will be returned (if available).

Possible values:

  • coded returns raw instruction data without human-readable messages.
  • text returns raw instructions data with human-readable messages in plain text.
  • tagged returns raw instruction data with tagged human-readable messages to permit formatting.

Note that the instructionsType parameter cannot be used in conjunction with routeRepresentation=none. If alternative routes are requested, instructions will be generated for each route returned.

Parameters
Name Description Required Type/Values Default
instructionsType If a street number is sent in along with the request, the response may include the side of the street (Left/Right) and also an offset position for that street number. No String None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or street number value if argument is omitted.

key([newValue]): String Chainable

Sets or returns the API key to be used in calls made by this service instance.

Setting a key for each instance of this class is not needed if the key was already setted globally using the tomtom.searchKey() function.

A valid API key is required to make use of the Online Search services. It can be issued from TomTom's Developer Portal.

Parameters
Name Description Required Type/Values Default
newValue key API Key valid for requested service No String None
Throws

If the given argument cannot be converted to a valid value

Returns

The same service instance or the current option value if no argument was given

language([language]): String Chainable

A setter and getter for 'language' attribute. The language parameter determines the language of the guidance messages. It does not affect proper nouns (the names of streets, plazas, etc.) It has no effect when instructionsType=coded. Allowed values are (a subset of) the IETF language tags described here. The currently supported languages are listed in the supported languages section:

https://developer.tomtom.com/online-routing/online-routing-documentation-routing/calculate-route#supportedlanguages

Parameters
Name Description Required Type/Values Default
language The language value No String None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or language if argument is omitted.

locations([locations]): String Chainable

A setter and getter for 'locations' attribute. Locations through which the route is calculated. The following constraints apply:

  • At least two locations must be provided.
  • The first location in the sequence defines the origin and must be of type point.
  • The last location in the sequence defines the destination and must be of type point.
  • One or more optional intermediate locations (known as waypoints) may be provided:
    • The maximum allowed number of waypoints is 50, reduced to 20 when computeBestOrder is true.
    • A point waypoint results in an extra leg in the response, a circle waypoint does not.
    • Circle waypoints cannot be used when computeBestOrder is true.

The points or circles that will be used to calculate the route. Following input types are allowed:

  1. string with Colon-delimited locations. For example
  2. array containing locations location can be defined as string,object or array

Parameters
Name Description Required Type/Values Default
locations This is the specified locations for route calculation. No String | Array None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or converted locations value if argument is omitted.

maxAlternatives([maxAlternatives]): Number Chainable

A setter and getter for 'maxAlternatives' attribute. Number of desired alternative routes to be calculated. The value provided: must be an integer in the range 0-5 using a value greater than 0 in conjunction with computeBestOrder set to true is not allowed fewer alternative routes may be returned if either fewer alternatives exist or the requested number of alternatives is larger than the service can calculate Default value is 0, Maximum value is 5

Parameters
Name Description Required Type/Values Default
maxAlternatives To restrict maximum alternative routes to be calculated. No Number None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or maxAlternatives value if argument is omitted.

maxChargeInkWh([maxChargeInkWh]): Number Chainable

A setter and getter for 'maxChargeInkWh' attribute. Specifies the maximum electric energy supply in kilowatt hours (kWh) that may be stored in t he vehicle's battery.

Parameters
Name Description Required Type/Values Default
maxChargeInkWh No Number None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

protocol([protocol]): String Chainable

A setter and getter for 'protocol' attribute. Represents type of protocol used to perform service call.

Parameters
Name Description Required Type/Values Default
protocol Protocol type, one of http or https. No String None
Throws

If the given argument cannot be converted to a valid value.

Returns

Method returns the service instance allowing chaining or <em>protocol</em> value if argument is omitted.

report([report]): String Chainable

A setter and getter for 'report' attribute. Specifies which data should be reported for diagnosis purposes. Possible values: effectiveSettings Reports the effective parameters or data used when calling the API. In the case of defaulted parameters the default will be reflected where the parameter was not specified by the caller.

Parameters
Name Description Required Type/Values Default
report Level of verbose answer from service, useful for debugging purposes. No String None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or language if argument is omitted.

routeRepresentation([routeRepresentation]): String Chainable

A setter and getter for 'routeRepresentation' attribute. Specifies the representation of the set of routes provided as response. Possible values:

  • polyline includes routes in the response.
  • none includes only the optimized waypoint indices but does not include the routes in the response.

This parameter value can only be used in conjunction with computeBestOrder true.

Parameters
Name Description Required Type/Values Default
routeRepresentation Allows the routing response to omit the actual route and give only the best ordered waypoints. No String None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or language if argument is omitted.

routeType([routeType]): String Chainable

A setter and getter for 'routeType' attribute. The type of route requested. Notes on specific values:

  • fastest returns the fastest route.
  • shortest returns the shortest route by distance.
  • eco routes balance economy and speed.
  • thrilling routes include interesting or challenging roads and use as few motorways as possible. You can choose the level of turns included and also the degree of hilliness. See the hilliness and windingness parameters for how to set this. There is a limit of 900 km on routes planned with routeType=thrilling

Default value is fastest

Parameters
Name Description Required Type/Values Default
routeType Route type to be used during route calculation. No String None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or route type value if argument is omitted.

traffic([traffic]): Boolean Chainable

A setter and getter for 'traffic' attribute. Possible values: true (do consider all available traffic information during routing) false (ignore current traffic data during routing). Note that although the current traffic data is ignored during routing, the effect of historic traffic on effective road speeds is still incorporated. Default is true

Parameters
Name Description Required Type/Values Default
traffic Boolean flag determine if traffic data should be used to calculate the route. No String | Boolean None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or traffic value if argument is omitted.

travelMode([travelMode]): String Chainable

A setter and getter for 'travelMode' attribute. The mode of travel for the requested route. Possible values: car, truck, taxi, bus, van, motorcycle, bicycle, pedestrian Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the element of the response for that section will be other.

Parameters
Name Description Required Type/Values Default
travelMode The primary mean of transportation to be used while routing. No String None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or language if argument is omitted.

uphillEfficiency([uphillEfficiency]): Number Chainable

A setter and getter for 'uphillEfficiency' attribute. Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation (i.e. PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed is obtained by converting consumed fuel to chemical energy using fuelEnergyDensityInMJoulesPerLiter.

Parameters
Name Description Required Type/Values Default
uphillEfficiency No Number None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

vehicleAxleWeight([vehicleAxleWeight]): Number Chainable

A setter and getter for 'vehicleAxleWeight' attribute. Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered during route planning. This parameter is currently only considered for travelMode truck.

Parameters
Name Description Required Type/Values Default
vehicleAxleWeight The vehicle axle wight in kg. No Number None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

vehicleCommercial([vehicleCommercial]): String Chainable

A setter and getter for 'vehicleCommercial' attribute. Vehicle is used for commercial purposes and thus may not be allowed to drive on some roads. This parameter is currently only considered for travelMode truck.

Parameters
Name Description Required Type/Values Default
vehicleCommercial True if vehicle is used for commercial purposes. No Boolean None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

vehicleEngineType([vehicleEngineType]): String Chainable

A setter and getter for 'vehicleEngineType' attribute. Engine type of the vehicle. This parameter is currently only considered for travelMode truck. Valid options are: combustion, electric

Parameters
Name Description Required Type/Values Default
vehicleEngineType The vehicle engine type. No String None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

vehicleHeading([vehicleHeading]): Number Chainable

A setter and getter for 'vehicleHeading' attribute. The directional heading of the vehicle in degrees starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359.

Parameters
Name Description Required Type/Values Default
vehicleHeading The angle in which the vehicle is heading. No Number None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

vehicleHeight([vehicleHeight]): Number Chainable

A setter and getter for 'vehicleHeight' attribute. Height of the vehicle in meters. A value of 0 means that height restrictions are not considered during route planning. This parameter is currently only considered for travelMode truck.

Parameters
Name Description Required Type/Values Default
vehicleHeight The vehicle height in m. No Number None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

vehicleLength([vehicleLength]): Number Chainable

A setter and getter for 'vehicleLength' attribute. Length of the vehicle in meters. A value of 0 means that length restrictions are not considered during route planning. This parameter is currently only considered for travelMode truck.

Parameters
Name Description Required Type/Values Default
vehicleLength The vehicle length in m. No Number None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

vehicleLoadType([vehicleLoadType]): Array Chainable

A setter and getter for 'vehicleLoadType' attribute. Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries.

Use these for routing in US

  • USHazmatClass1 Explosives
  • USHazmatClass2 Compressed gas
  • USHazmatClass3 Flammable liquids
  • USHazmatClass4 Flammable solids
  • USHazmatClass5 Oxidizers
  • USHazmatClass6 Poisons
  • USHazmatClass7 Radioactive
  • USHazmatclass8 Corrosives
  • USHazmatClass9 Miscellaneous

Use these for routing in all other countries

  • otherHazmatExplosive Explosives
  • otherHazmatGeneral Miscellaneous
  • otherHazmatHarmfulToWater Harmful to water

This parameter is currently only considered for travelMode truck.

Parameters
Name Description Required Type/Values Default
vehicleLoadType The array of truck cargo classification. No Array | String None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

vehicleMaxSpeed([vehicleMaxSpeed]): Number Chainable

A setter and getter for 'vehicleMaxSpeed' attribute. Maximum speed of the vehicle in km/hour. A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning. A non-zero value may be overridden during route planning. This parameter is currently only considered for travelMode truck.

Parameters
Name Description Required Type/Values Default
vehicleMaxSpeed The maximal allowed vehicle speed in km/h. No Number None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

vehicleWeight([vehicleWeight]): Number Chainable

A setter and getter for 'vehicleWeight' attribute. Weight of the vehicle in kg. A value of 0 means that weight restrictions are not considered during route planning. This parameter is currently only considered for travelMode truck.

Parameters
Name Description Required Type/Values Default
vehicleWeight The vehicle weight in kg. No Number None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

vehicleWidth([vehicleWidth]): Number Chainable

A setter and getter for 'vehicleWidth' attribute. Width of the vehicle in meters. A value of 0 means that width restrictions are not considered during route planning. This parameter is currently only considered for travelMode truck.

Parameters
Name Description Required Type/Values Default
vehicleWidth The vehicle width in m. No Number None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or current value if argument is omitted.

windingness([windingness]): String Chainable

A setter and getter for 'windingness' attribute. Level of turns for thrilling route. Possible values: low, normal, high This parameter can only be used in conjunction with routeType thrilling.

Parameters
Name Description Required Type/Values Default
windingness The level of windingness on a thrilling route. No String None
Throws

if the given argument cannot be converted to a valid value

Returns

Method returns the service instance allowing chaining or language if argument is omitted.