JavaScript Maps SDK

Routing Layer

Contents

The alk.layer.RoutingLayer layer is used to display routes.

Add A Route

Once you have added a routing layer to your map, you can add a route to the layer. Descriptions for the parameters can be found in the table below.

Options

The routeServiceOptions parameter contains options related to the generation of the route and optional reports.

Parameter Type/Values Description
vehicleType [0 | 1 | 2] Default: 0
Restricts the route to roads that are accessible by the selected vehicle type.
  • 0 - Truck (Default)
  • 1 - Light Truck
  • 2 - Automobile
  • 3 - Midsize Truck
  • 4 - School Bus
routingType [0 | 1 | 2] Default: 0
Generated the route to match the type.
  • 0 - Practical
  • 1 - Shortest
  • 2 - Fastest
routeOptimization [0 | 1 | 2] Default: 0
  • 0 - None
  • 1 - Optimize All Stops
  • 2 - Optimize Intermediate Stops
tollDiscourage boolean Default: false
Generates the route by trying to avoid toll roads.
classOverrides [0 | 1 | 2 | 3] Default: 0
  • 0 - Indicates that no class overrides are present.
  • 1 - Indicates a 53' class override.
  • 2 - Indicates a National Network class override.
  • 3 - Indicates a 53' and National Network class override.
bordersOpen boolean Default: true
Set to True to allow international border crossings, False to avoid or reduce number of international border crossings. For example, if all your stops are in the “lower 48” United States, the resulting route will stay in the United States even if the most practical or shortest route would normally involve some Canadian mileage. For EU travel, setting this to False will reduce the number of EU border crossings where possible and the route will follow the best path within the country from which the route originates.
overrideRestrict boolean Default: false
Indicates whether or not to override truck restrictions
highwayOnly boolean Default: false
Restricts the route to only highway roads.
hazMatType [0 | 1 | 2 | 3 | 4 | 5 | 6] Default: 0
Restricts the route to roads that allow transportation of the selected hazardous material.
  • 0 - None
  • 1 - General
  • 2 - Caustic
  • 3 - Explosives
  • 4 - Flammable
  • 5 - Inhalants
  • 6 - Radioactive
distanceUnits [0 | 1] Default: 0
Distance units as miles or kilometers.
  • 0 - Miles
  • 1 - Kilometers
trkUnits [0 | 1] Default: 0
Vehicle dimension units; can be English or Metric.
  • 0 - Indicates that vehicle dimension units should be English, e.g., 13'6".
  • 1 - Indicates that vehicle dimension units should be metric.
trkHeight number The height of the vehicle in feet and inches or meters depending on units. Example 13'6" or 4.1148.
trkLength number The length of the vehicle in feet and inches or meters depending on units. Example 13'6" or 4.1148.
trkWidth number The width of the vehicle in feet and inches or meters depending on units. Example 13'6" or 4.1148.
trkWeight number The weight of the vehicle in pounds or kilograms depending on units.
trkAxles number Default: 5
The number of axles on the vehicle; acceptable values are 2 through 14.
inclFerryDist boolean Default: true
Indicates whether or not to include ferry distances in mileage calculations.
fuelUnits [0 | 1] Default: 0
Fuel units as gallons and liters.
  • 0 - Gallons
  • 1 - Liters
truckConfig [0 | 1 | 2 | 3 | 4] Default: 0
The vehicle style.
  • 0 - Indicates that no particular vehicle style is chosen.
  • 1 - 28' double trailer.
  • 2 - 40' straight trailer.
  • 3 - 48' semitrailer.
  • 4 - 53' semitrailer
inclTollData boolean Default: true
Indicates whether or not reports should calculate toll costs.
fuelEconLoad number The fuel efficiency (distance units per fuel units) when loaded.
fuelEconEmpty number The fuel efficiency (distance units per fuel units) when empty.
costPerFuelUnit number The cost per fuel unit of fuel.
costGHG number The cost of greenhouse gas in lbs. per fuel unit.
costMaintLoad number The maintenance cost per distance unit when loaded.
costMaintEmpty number The maintenance cost per distance unit when empty.
costTimeLoad number The time cost per mile/km when loaded.
costTimeEmpty number The time cost per mile/km when empty.
tollCurrency [0 | 1] Default: 0
The toll currency.
  • 0 - Indicates that the currency should be United States dollars.
  • 1 - Indicates that the currency should be Canadian dollars.
exchangeRate number The change rate to convert US dollars to Canadian dollars.
citeInt number The cite interval to be used when generating a geotunnel report. The minimum value is 0.1.
region [NA | EU | OC | SA | AS | AF | ME] Default: NA
The data region in which the route stops are located.

Note: If region is not provided, region value will be inherited from baseLayer region parameter.
dataset [Current | PCM_EU | PCM_OC | PCM_SA
| PCM_AF | PCM_ME | PCM_IN | PCM_SE] 		Default: Current
For users licensed for multiple regional datasets.
Last updated January 27, 2023.
Contents