Options
All
  • Public
  • Public/Protected
  • All
Menu

A distance matrix query sent by the DistanceMatrixService containing arrays of origin and destination locations, and various options for computing metrics.

Hierarchy

  • DistanceMatrixRequest

Index

Properties

Optional avoidFerries

avoidFerries?: boolean

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

Optional avoidHighways

avoidHighways?: boolean

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

Optional avoidTolls

avoidTolls?: boolean

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

destinations

destinations: (string | LatLng | LatLngLiteral | Place)[]

An array containing destination address strings, or LatLng, or Place objects, to which to calculate distance and time. Required.

Optional drivingOptions

drivingOptions?: DrivingOptions

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

origins

origins: (string | LatLng | LatLngLiteral | Place)[]

An array containing origin address strings, or LatLng, or Place objects, from which to calculate distance and time. Required.

Optional region

region?: string

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

Optional transitOptions

transitOptions?: TransitOptions

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

travelMode

travelMode: TravelMode

Type of routing requested. Required.

Optional unitSystem

unitSystem?: UnitSystem

Preferred unit system to use when displaying distance. Optional; defaults to metric.

Generated using TypeDoc