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

avoidFerries?: boolean

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

avoidHighways?: boolean

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

avoidTolls?: boolean

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

destinations: (string | LatLng | LatLngLiteral | google.maps.Place)[]

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

drivingOptions?: DrivingOptions

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

language?: null | string

A language identifier for the language in which results should be returned, when possible. See the list of supported languages.

origins: (string | LatLng | LatLngLiteral | google.maps.Place)[]

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

region?: null | string

Region code used as a bias for geocoding requests. The region code accepts a ccTLD ("top-level domain") two-character value. Most ccTLD codes are identical to ISO 3166-1 codes, with some notable exceptions. For example, the United Kingdom's ccTLD is "uk" (.co.uk) while its ISO 3166-1 code is "gb" (technically for the entity of "The United Kingdom of Great Britain and Northern Ireland").

transitOptions?: TransitOptions

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

travelMode: TravelMode

Type of routing requested. Required.

unitSystem?: UnitSystem

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

Generated using TypeDoc