Route Matrix

RouteMatrix 类

class google.maps.routes.RouteMatrix
library "routes"

由 RouteMatrix.computeRouteMatrix 为一组出发地/目的地对计算出的路线矩阵

const {RouteMatrix} = await google.maps.importLibrary("routes");
computeRouteMatrix
computeRouteMatrix(request)
参数:
返回值:Promise<{matrix:RouteMatrix}>
接受出发地和目的地列表,并返回一个矩阵,其中包含每个出发地和目的地组合的路线信息。

注意:此方法要求您通过设置 ComputeRouteMatrixRequest.fields 属性在请求中指定响应字段掩码。该值是字段路径的列表。

例如:
  • 所有可用字段的字段掩码:fields: ['*']
  • 路线级时长和距离的字段掩码:fields: ['durationMillis', 'distanceMeters']

不建议使用通配符响应字段掩码 fields: ['*'],原因如下:
  • 仅选择您需要的字段有助于我们的服务器节省计算周期,从而以更低的延迟向您返回结果。
  • 仅选择生产作业中所需的字段可确保稳定的延迟时间性能。我们将来可能会添加更多响应字段,这些新字段可能需要额外的计算时间。如果您选择所有字段,或选择顶层的所有字段,则可能会遇到性能下降的情况,因为我们添加的任何新字段都会自动包含在响应中。
  • 仅选择所需的字段会使响应大小更小,从而加快通过网络加载的速度。
rows
readonly
矩阵的行。每行对应一个出发地,并包含一个 RouteMatrixItem 数组,每个表示一条前往目的地的路线。
继承: toJSON

RouteMatrixRow 类

class google.maps.routes.RouteMatrixRow
library "routes"

对应于传递给 RouteMatrix.computeRouteMatrix 的来源。包含 RouteMatrixItem 列表,其中每个项都表示前往目的地的路线。

const {RouteMatrixRow} = await google.maps.importLibrary("routes");
items
readonly
每个目的地的路线信息。
继承: toJSON

RouteMatrixItem 类

class google.maps.routes.RouteMatrixItem
library "routes"

包含为传递给 RouteMatrix.computeRouteMatrix 的出发地/目的地对计算的路线信息。

const {RouteMatrixItem} = await google.maps.importLibrary("routes");
condition
readonly
类型:RouteMatrixItemCondition optional
指示是否找到了路线。
distanceMeters
readonly
类型:number optional
路线的行程距离(以米为单位)。
durationMillis
readonly
类型:number optional
沿路线导航所需的时间长度(以毫秒为单位)。如果您将 ComputeRouteMatrixRequest.routingPreference 设置为 TRAFFIC_UNAWARE,则此值与 RouteMatrixItem.staticDurationMillis 相同。如果您将 ComputeRouteMatrixRequest.routingPreference 设置为 TRAFFIC_AWARE 或 TRAFFIC_AWARE_OPTIMAL,则系统会在计算此值时考虑路况信息。

注意:如果时长超过 2^53 毫秒,则此值为 Number.POSITIVE_INFINITY。
error
readonly
类型:RouteMatrixItemError optional
计算路线期间发生的错误。
fallbackInfo
readonly
类型:FallbackInfo optional
在某些情况下,如果服务器无法使用给定偏好设置计算此特定起点/终点对的路线,则可能会回退到使用其他计算模式。使用后备时,此字段包含有关后备响应的详细信息。否则,此字段将处于未设置状态。
localizedValues
readonly
RouteMatrixItem 属性的文本表示。
staticDurationMillis
readonly
类型:number optional
在不考虑路况信息的情况下,沿路线行驶的时长。

注意:如果时长超过 2^53 毫秒,则此值为 Number.POSITIVE_INFINITY。
travelAdvisory
readonly
类型:RouteTravelAdvisory optional
有关路线的其他信息。

ComputeRouteMatrixRequest 接口

接口 google.maps.routes.ComputeRouteMatrixRequest

路线矩阵请求。

destinations
目的地数组,用于确定响应矩阵的列。作为字符串传递的值可以是地址、Plus Code 或地点资源名称。系统不会考虑海拔值。
fields
类型:Iterable<string>
要提取的字段集合。为所有字段指定 ["*"]。
origins
起点数组,用于确定响应矩阵的行。作为字符串传递的值可以是地址、Plus Code 或地点资源名称。系统不会考虑海拔值。

起点和终点的基数存在多项大小限制:
arrivalTime
可选
类型:Date optional
到达时间。

注意:只有当 ComputeRouteMatrixRequest.travelMode 设置为 TRANSIT 时才能设置此项。您可以指定 ComputeRouteMatrixRequest.departureTime 或 ComputeRouteMatrixRequest.arrivalTime,但不能同时指定这两者。您可以查看过去 7 天内或未来 100 天内的公交行程。
departureTime
可选
类型:Date optional
出发时间。如果您未设置此值,则此值默认为您发出请求的时间。

注意:只有当 ComputeRouteMatrixRequest.travelMode 设置为 TRANSIT 时,您才能指定过去的时间。您可以查看过去 7 天内或未来 100 天内的公交行程。
extraComputations
可选
可能用于完成请求的额外计算列表。

注意:这些额外的计算可能会在响应中返回额外的字段。这些额外字段还必须在 ComputeRouteMatrixRequest.fields 中指定,以便在响应中返回。
internalUsageAttributionIds
可选
类型:Iterable<string> optional
用于将调用归因于特定软件包或 OSS 库的标识符。
language
可选
类型:string optional
BCP-47 语言代码,例如“en-US”或“sr-Latn”。如需了解详情,请参阅 Unicode 语言区域标识符。如需查看支持的语言列表,请参阅语言支持。如果您未提供此值,系统会根据您的 Google Maps JavaScript API 本地化设置推断语言。否则,系统会根据第一个来源的位置推断语言。
region
可选
类型:string optional
地区代码,以 ccTLD(“顶级域名”)双字符值的形式指定。如需了解详情,请参阅国家/地区代码顶级域名。如果您未提供此值,系统会根据您的 Google Maps JavaScript API 本地化设置推断区域。否则,系统会根据第一个源站的位置推断区域。
routingPreference
可选
类型:RoutingPreference optional
指定如何计算路线矩阵。服务器会尝试使用所选路线偏好设置来计算路线矩阵。如果路由偏好设置导致错误或超长延迟时间,则会返回错误。只有当 ComputeRouteMatrixRequest.travelMode 为 DRIVING 或 TWO_WHEELER 时,您才能指定此选项,否则请求会失败。
trafficModel
可选
类型:TrafficModel optional
指定计算交通时间时要使用的假设条件。此设置会影响 RouteMatrixItem.durationMillis 中返回的值,该值包含根据历史平均数据预测的交通时间。ComputeRouteMatrixRequest.trafficModel 仅适用于将 ComputeRouteMatrixRequest.routingPreference 设置为 TRAFFIC_AWARE_OPTIMAL 且将 ComputeRouteMatrixRequest.travelMode 设置为 DRIVING 的请求。默认值为 BEST_GUESS。
transitPreference
可选
类型:TransitPreference optional
指定影响为 TRANSIT 路线返回的路线的偏好设置。

注意:仅当 ComputeRouteMatrixRequest.travelMode 设置为 TRANSIT 时,才能指定此参数。
travelMode
可选
类型:TravelMode optional
指定交通方式。
units
可选
类型:UnitSystem optional
指定显示字段的度量单位。如果您未提供此值,则系统会根据第一个出发地的位置推断显示单位。

ComputeRouteMatrixExtraComputation 常量

常量 google.maps.routes.ComputeRouteMatrixExtraComputation
库 "routes"

完成请求时要执行的额外计算。如需了解详情,请参阅网络服务文档。

这些常量也可以用作字符串。在 TypeScript 中,字符串字面量由 ComputeRouteMatrixExtraComputationString 类型定义。

const {ComputeRouteMatrixExtraComputation} = await google.maps.importLibrary("routes");
TOLLS 矩阵元素的通行费信息。如需了解详情,请参阅网络服务文档。

RouteMatrixItemCondition 常量

常量 google.maps.routes.RouteMatrixItemCondition
库 "routes"

返回的路线的条件。如需了解详情,请参阅网络服务文档。

这些常量也可以用作字符串。在 TypeScript 中,字符串字面量由 RouteMatrixItemConditionString 类型定义。

const {RouteMatrixItemCondition} = await google.maps.importLibrary("routes");
ROUTE_EXISTS 系统找到了路线,并为该元素填写了相应信息。如需了解详情,请参阅网络服务文档。
ROUTE_NOT_FOUND 找不到路线。如需了解详情,请参阅网络服务文档。

RouteMatrixItemError 类

class google.maps.routes.RouteMatrixItemError extends Error
library "routes"

在特定出发地/目的地对的 RouteMatrix.computeRouteMatrix 期间发生的错误。

const {RouteMatrixItemError} = await google.maps.importLibrary("routes");
继承: toJSON

RouteMatrixItemLocalizedValues 类

class google.maps.routes.RouteMatrixItemLocalizedValues
library "routes"

RouteMatrixItem 的文本表示。

const {RouteMatrixItemLocalizedValues} = await google.maps.importLibrary("routes");
distance
readonly
类型:string optional
路线矩阵项的行程距离(文本形式)。
distanceLanguage
readonly
类型:string optional
距离文本的 BCP-47 语言代码,例如“en-US”或“sr-Latn”。

如需了解详情,请参阅 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier。
duration
readonly
类型:string optional
时长,以文本形式表示,并根据查询所在地区进行本地化。考虑路况信息。

注意:如果您未请求路况信息,则此值与 RouteMatrixItemLocalizedValues.staticDuration 的值相同。
durationLanguage
readonly
类型:string optional
时长文本的 BCP-47 语言代码,例如“en-US”或“sr-Latn”。

如需了解详情,请参阅 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier。
staticDuration
readonly
类型:string optional
不考虑路况信息的时长,以文本形式表示。
staticDurationLanguage
readonly
类型:string optional
静态时长文本的 BCP-47 语言代码,例如“en-US”或“sr-Latn”。
transitFare
readonly
类型:string optional
公交票价,以文本形式表示。
transitFareLanguage
readonly
类型:string optional
公交票价文本的 BCP-47 语言代码,例如“en-US”或“sr-Latn”。

如需了解详情,请参阅 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier。
继承: toJSON

RouteMatrixOrigin 接口

接口 google.maps.routes.RouteMatrixOrigin

ComputeRouteMatrixRequest 的单个来源。

waypoint
源站的位置。作为字符串传递的值可以是地址或 Plus Code。系统不会考虑海拔值。
routeModifiers
可选
类型:RouteModifiers optional
以此为出发地的每条路线的修饰符。