L.ALKMaps.Layer.Routing layer is used to retrieve, display, and get reports for routes.
Add A Route
Once you have added a routing layer to your map, you can begin adding routes to the layer. The
addRoute function of the routing layer has up to six parameters:
reportOptions, and the
failure callback functions. Descriptions for these parameters can be found in the table below.
stops parameter of the
addRoute method should contain an array of
L.latLng objects representing the stops of the route.
options parameter contains options related to the generation of the route and optional reports.
Restricts the route to roads that are accessible by the selected vehicle type.
Generated the route to match the type.
Generates the route by trying to avoid toll roads.
Indicates whether borders are open for travel.
Indicates whether or not to override truck restrictions
Restricts the route to only highway roads.
Restricts the route to roads that allow transportation of the selected hazardous material.
Indicates the tunnel categories, which are applicable for EU region only.
|Maximum average road speed to use in route calculations that overrides all other road speeds when they are above this value.
Default is disabled and valid value is between 1 and 100 mph or 1 and 161 kph based on |
Distance units as miles or kilometers.
Vehicle dimension units; can be English or Metric.
|The height of the vehicle in feet and inches or meters depending on units. Example 13'6" or 4.1148.|
|The length of the vehicle in feet and inches or meters depending on units. Example 13'6" or 4.1148.|
|The width of the vehicle in feet and inches or meters depending on units. Example 13'6" or 4.1148.|
|The weight of the vehicle in pounds or kilograms depending on units.|
The number of axles on the vehicle; acceptable values are 2 through 14.
Indicates whether or not to include ferry distances in mileage calculations.
Fuel units as gallons and liters.
The vehicle style.
Indicates whether or not reports should calculate toll costs.
|The fuel efficiency (distance units per fuel units) when loaded.|
|The fuel efficiency (distance units per fuel units) when empty.|
|The cost per fuel unit of fuel.|
|The cost of greenhouse gas in lbs. per fuel unit.|
|The maintenance cost per distance unit when loaded.|
|The maintenance cost per distance unit when empty.|
|The time cost per mile/km when loaded.|
|The time cost per mile/km when empty.|
The toll currency.
|The change rate to convert US dollars to Canadian dollars.|
|The cite interval to be used when generating a geotunnel report. The
minimum value is 0.1.|
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.
For users licensed for multiple regional datasets.
functionOptions parameter contains options related to the functionality of the actual layer.
|User defined id for the route.|
|Object containing styling properties to be used for the visualization of the route. If not provided, one of the pre-defined route styles will be used.|
|Determines whether or not the map will zoom to fit all the routes on the layer.|
|Determines whether or not to display the graphics that normally display at each of the route’s stops.|
reportOptions parameter contains options related to the creation of the different route reports and formats.
|Comma-separated list of requested report types.|
The format of the report returned with the route.
Arrows Along Route
The following piece of sample code demonstrates a route with arrows. The plugin is provided by Benjamin Becquet.