Skip to content

Latest commit

 

History

History
88 lines (45 loc) · 3.65 KB

DirectionsRequest.md

File metadata and controls

88 lines (45 loc) · 3.65 KB

See html formatted version

DirectionsRequest interface

google.maps.DirectionsRequest interface

A directions query to be sent to the DirectionsService.

Properties

undefined

Type:  boolean optional

If true, instructs the Directions service to avoid ferries where possible. Optional.

undefined

Type:  boolean optional

If true, instructs the Directions service to avoid highways where possible. Optional.

undefined

Type:  boolean optional

If true, instructs the Directions service to avoid toll roads where possible. Optional.

undefined

Type:  string|LatLng|Place|LatLngLiteral

Location of destination. This can be specified as either a string to be geocoded, or a LatLng, or a Place. Required.

undefined

Type:  DrivingOptions optional

Settings that apply only to requests where travelMode is DRIVING. This object will have no effect for other travel modes.

undefined

Type:  boolean optional

If set to true, the DirectionsService will attempt to re-order the supplied intermediate waypoints to minimize overall cost of the route. If waypoints are optimized, inspect DirectionsRoute.waypoint_order in the response to determine the new ordering.

undefined

Type:  string|LatLng|Place|LatLngLiteral

Location of origin. This can be specified as either a string to be geocoded, or a LatLng, or a Place. Required.

undefined

Type:  boolean optional

Whether or not route alternatives should be provided. Optional.

undefined

Type:  string optional

Region code used as a bias for geocoding requests. Optional.

undefined

Type:  TransitOptions optional

Settings that apply only to requests where travelMode is TRANSIT. This object will have no effect for other travel modes.

undefined

Type:  TravelMode

Type of routing requested. Required.

undefined

Type:  UnitSystem optional

Preferred unit system to use when displaying distance. Defaults to the unit system used in the country of origin.

undefined

Type:  Array<DirectionsWaypoint> optional

Array of intermediate waypoints. Directions are calculated from the origin to the destination by way of each waypoint in this array. See the developer's guide for the maximum number of waypoints allowed. Waypoints are not supported for transit directions. Optional.