Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IDirectionArgs

An interface for a container of arguments passed to the Directions class. Specifies the unit system and culture of the direction.

Hierarchy

Index

Properties

culture

culture: string

The culture to use for the directions (e.g. en-US for US English).

Optional customRoutingAccessKeys

customRoutingAccessKeys: string[]

The custom routing access key used internally to look up customer specific data to be applied to the route.

stops

stops: IRouteStop[]

An array of IRouteStop objects, which represent stops along the route to be calculated.

strategy

The routing strategy to use when calculating the route.

Optional trafficServer

trafficServer: string

The server to use for getting traffic information relevant to the route.

unitSystem

unitSystem: UnitSystem

The type of unit system to use for the directions (e.g. Metric).

Optional vehicleSpec

vehicleSpec: IVehicleSpec

The specifications for the vehicle to use when calculating the route.

Generated using TypeDoc