Класс 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: ['*'] не рекомендуется по следующим причинам:
|
Свойства | |
|---|---|
rows
readonly |
Тип:
Array<RouteMatrixRow>Строки матрицы. Каждая строка соответствует пункту отправления и содержит массив элементов RouteMatrixItem, каждый из которых представляет маршрут до пункта назначения. |
Методы | |
|---|---|
Унаследованные:
toJSON
|
Класс RouteMatrixRow
class
google.maps.routes.RouteMatrixRow
library "routes"
Соответствует источнику, переданному в RouteMatrix.computeRouteMatrix. Содержит список объектов RouteMatrixItem, каждый из которых представляет маршрут до пункта назначения.
const {RouteMatrixRow} = await google.maps.importLibrary("routes");
Свойства | |
|---|---|
items
readonly |
Тип:
Array<RouteMatrixItem>Информация о маршруте для каждого пункта назначения. |
Методы | |
|---|---|
Унаследованные:
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 |
Тип:
RouteMatrixItemLocalizedValues optionalТекстовые представления свойств RouteMatrixItem. |
staticDurationMillis
readonly |
Тип:
number optionalПродолжительность поездки по маршруту без учета загруженности дорог. Примечание. Если продолжительность превышает 2^53 миллисекунд, то это значение равно Number.POSITIVE_INFINITY. |
travelAdvisory
readonly |
Тип:
RouteTravelAdvisory optionalДополнительная информация о маршруте. |
Интерфейс ComputeRouteMatrixRequest
интерфейс
google.maps.routes.ComputeRouteMatrixRequest
Запрос матрицы маршрутов.
Свойства | |
|---|---|
destinations |
Тип:
Iterable<string|LatLng|LatLngLiteral|LatLngAltitudeLiteral|DirectionalLocationLiteral|Place|Waypoint>Массив пунктов назначения, определяющий столбцы матрицы ответа. Значение, переданное в виде строки, может быть адресом, плюс-кодом или названием ресурса места. Значения высоты не учитываются. |
fields |
Тип:
Iterable<string>Набор полей, которые нужно получить. Укажите ["*"] для всех полей. |
origins |
Тип:
Iterable<string|LatLng|LatLngLiteral|LatLngAltitudeLiteral|DirectionalLocationLiteral|Place|RouteMatrixOrigin|Waypoint>Массив пунктов отправления, определяющий строки матрицы ответа. Значение, переданное в виде строки, может быть адресом, плюс-кодом или названием ресурса места. Значения высоты не учитываются. На количество уникальных значений пунктов отправления и назначения накладывается несколько ограничений:
|
arrivalTime
необязательно |
Тип:
Date optionalВремя прибытия. Примечание. Это значение можно задать, только если для параметра ComputeRouteMatrixRequest.travelMode установлено значение TRANSIT. Вы можете указать либо ComputeRouteMatrixRequest.departureTime, либо ComputeRouteMatrixRequest.arrivalTime, но не оба значения. Вы можете посмотреть маршруты общественного транспорта за последние 7 дней или на 100 дней вперед. |
departureTime
необязательно |
Тип:
Date optionalВремя отправления. Если вы не зададите это значение, по умолчанию будет использоваться время, когда вы сделали запрос. Примечание. Вы можете указать время в прошлом, только если для параметра ComputeRouteMatrixRequest.travelMode задано значение TRANSIT. Вы можете посмотреть маршруты общественного транспорта за последние 7 дней или на 100 дней вперед. |
extraComputations
необязательно |
Тип:
Iterable<ComputeRouteMatrixExtraComputation> optionalСписок дополнительных вычислений, которые могут использоваться для выполнения запроса. Примечание. В результате этих дополнительных вычислений в ответе могут появиться дополнительные поля. Чтобы эти дополнительные поля возвращались в ответе, их также необходимо указать в ComputeRouteMatrixRequest.fields. |
internalUsageAttributionIds
необязательно |
Тип:
Iterable<string> optionalИдентификаторы, используемые для соотнесения вызовов с определенными пакетами или библиотеками OSS. |
language
необязательно |
Тип:
string optionalКод языка по стандарту BCP-47, например "ru-RU" или "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, например "ru-RU" или "sr-Latn". Подробную информацию можно найти на странице http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. |
duration
readonly |
Тип:
string optionalПродолжительность в текстовом формате, локализованная для региона запроса. Учитывает загруженность дорог. Примечание. Если вы не запрашивали информацию о трафике, это значение будет совпадать со значением RouteMatrixItemLocalizedValues.staticDuration. |
durationLanguage
readonly |
Тип:
string optionalКод языка по стандарту BCP-47, например "ru-RU" или "sr-Latn". Подробную информацию можно найти на странице http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. |
staticDuration
readonly |
Тип:
string optionalПродолжительность без учета загруженности дорог, представленная в текстовом формате. |
staticDurationLanguage
readonly |
Тип:
string optionalКод языка по стандарту BCP-47, например "ru-RU" или "sr-Latn". |
transitFare
readonly |
Тип:
string optionalСтоимость проезда в текстовом формате. |
transitFareLanguage
readonly |
Тип:
string optionalКод языка по стандарту BCP-47, например "ru-RU" или "sr-Latn". Подробную информацию можно найти на странице http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. |
Методы | |
|---|---|
Унаследованные:
toJSON
|
Интерфейс RouteMatrixOrigin
интерфейс
google.maps.routes.RouteMatrixOrigin
Один источник для ComputeRouteMatrixRequest.
Свойства | |
|---|---|
waypoint |
Местоположение источника. Значение, переданное в виде строки, может быть адресом или плюс-кодом. Значения высоты не учитываются. |
routeModifiers
необязательно |
Тип:
RouteModifiers optionalМодификаторы для каждого маршрута, который использует это место в качестве начальной точки. |