Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IRoutingStrategy

An interface for a RoutingStrategy, which is a set of constraints to which the routing engine should adhere when calculating a route.

Hierarchy

  • IRoutingStrategy

Index

Properties

Optional allowUTurns

allowUTurns: boolean

Whether or not u-turns are allowed as part of the route.

Optional crossingTurnPenaltySeconds

crossingTurnPenaltySeconds: number

The number of seconds that are added as a penality to the route calculation for crossing the road.

Optional deadendUTurnBehavior

deadendUTurnBehavior: string

Whether the route is allowed to include u-turns at the end of a dead-end road. Or whether u-turns at dead-end roads are forbidden or discouraged.

Optional obeyPreferredConstraints

obeyPreferredConstraints: boolean

When true, the routing engine uses preferred constraints. May introduce a performance penalty. When false, preferred constraints are not obeyed.

Optional roadCrossingBehavior

roadCrossingBehavior: string

Whether the route is allowed to include instructions to cross the opposite side of the road with oncoming traffic. Or whether road crossings are forbidden or discouraged.

Optional strategyType

strategyType: string

The type of routing strategy, e.g. fastest, shortest or for pedestrians

Optional uTurnPenaltySeconds

uTurnPenaltySeconds: number

The number of seconds that are added as a penality to the route calculation for doing a u-turn.

Optional useTollRoads

useTollRoads: boolean

Whether or not the route is allowed to include toll roads.

Generated using TypeDoc