| RoutingSettings data type |
The data type RoutingSettings is a nested data type that encapsulates the route settings of a given object. These settings are used by the routing engine to help plan the optimal route based on your unique requirements.
SubfieldsFor more information about working with subfields, see Accessing subfields.
The RoutingSettings data type contains the following subfields:
| Subfield | Data Type | Description |
|---|---|---|
| HasSameSideRouting | BoolType | Determines if Same Side Routing is enabled for the route. If Same Side Routing is enabled, u-turns are enabled by default. |
| TollRoadsAllowed | BoolType | Gets or sets whether this route is or is not allowed to use toll roads. Default is true. |
| UTurnsAllowed | BoolType | When true, allows the routing engine to instruct a u-turn. When false, generated routes will not contain u-turns if possible. Default is true. |
| FerriesAllowed | BoolType | Sets whether ferry crossings are allowed (true) or should be avoided as much as possible (false). Default is true. |
| UseHistoricTraffic | BoolType | Determines if routing cost estimates take into account historical traffic data for the roads the routed vehicle travels along. For example, some routes take longer to complete during peak traffic hours on weekdays. |
| UseLiveTraffic | BoolType | Determines if routing cost estimates take into account live traffic data for the roads the routed vehicle travels along. |
| VehicleType | EnumType | The classification of the vehicle. |
| VehicleHeight | Distance | Maximum height of the vehicle. |
| VehicleLength | Distance | Maximum length of the vehicle. |
| VehicleWidth | Distance | Maximum width of the vehicle. |
| VehicleDistanceFromKingpinToLastAxle | Distance | Distance from the kingpin to the last trailer axle. |
| VehicleGrossWeight | Weight | Total weight of the vehicle (including fuel, cargo and passengers). |
| VehicleUnladenWeight | Weight | Unladen (without cargo) weight of the vehicle. |
| VehicleNumberOfAxles | Number | Total number of axles on this vehicle (including trailers). |
| VehicleNumberOfWheels | Number | Total number of wheels on this vehicle. |
| VehicleNumberOfTrailers | Number | Total number of trailers pulled by this vehicle. |
JavaScript conversionWhen you use the optional [Script] section section to insert your own JavaSCript functions, access this data type as follows:
- Constructor
- JavaScript
new RoutingSettings({UseLiveTraffic:true,VehicleNumberOfAxles:2})
- Available fields for (get,set)
You can access these RoutingSettings elements as fields:
.HasSameSideRouting
.TollRoadsAllowed
.UTurnsAllowed
.FerriesAllowed
.UseHistoricTraffic
.UseLiveTraffic
.VehicleType
.VehicleHeight
.VehicleLength
.VehicleWidth
.VehicleDistanceFromKingpinToLastAxle
.VehicleGrossWeight
.VehicleUnladenWeight
.VehicleNumberOfAxles
.VehicleNumberOfWheels
.VehicleNumberOfTrailers