Directions

класс DirectionsService

google.maps . DirectionsService класс google.maps . DirectionsService

Сервис для расчета направления между двумя или более местами.

Получите доступ, вызвав const {DirectionsService} = await google.maps.importLibrary("routes") . См. Библиотеки в Maps JavaScript API .

DirectionsService
DirectionsService()
Параметры: Нет
Создает новый экземпляр DirectionsService , который отправляет запросы маршрутов на серверы Google.
route
route(request[, callback])
Параметры:
Возвращаемое значение: Promise < DirectionsResult >
Отправьте запрос на поиск маршрута.

Интерфейс DirectionsRequest

google.maps . DirectionsRequest Интерфейс google.maps . DirectionsRequest

Запрос направления, который будет отправлен в DirectionsService .

destination
Тип: string| LatLng | Place | LatLngLiteral
Место назначения. Это можно указать либо как строку для геокодирования, либо как LatLng , либо как Place . Необходимый.
origin
Тип: string| LatLng | Place | LatLngLiteral
Место происхождения. Это можно указать либо как строку для геокодирования, либо как LatLng , либо как Place . Необходимый.
travelMode
Тип: TravelMode
Запрошенный тип маршрутизации. Необходимый.
avoidFerries optional
Тип: boolean optional
Если true , служба Directions дает указание избегать паромов, где это возможно. Необязательный.
avoidHighways optional
Тип: boolean optional
Если true , служба Directions указывает, что следует по возможности избегать автомагистралей. Необязательный.
avoidTolls optional
Тип: boolean optional
Если true , служба Directions указывает, что по возможности следует избегать платных дорог. Необязательный.
drivingOptions optional
Тип: DrivingOptions optional
Настройки, которые применяются только к запросам, для которых travelMode имеет DRIVING . Этот объект не повлияет на другие режимы движения.
language optional
Тип: string optional
Идентификатор языка для языка, на котором должны быть возвращены результаты, когда это возможно. См. список поддерживаемых языков .
optimizeWaypoints optional
Тип: boolean optional
Если установлено значение true , DirectionsService попытается изменить порядок предоставленных промежуточных путевых точек, чтобы минимизировать общую стоимость маршрута. Если путевые точки оптимизированы, проверьте DirectionsRoute.waypoint_order в ответе, чтобы определить новый порядок.
provideRouteAlternatives optional
Тип: boolean optional
Должны ли быть предоставлены альтернативные маршруты. Необязательный.
region optional
Тип: string optional
Код региона, используемый в качестве смещения для запросов геокодирования. Код региона принимает двухсимвольное значение ccTLD («домен верхнего уровня») . Большинство кодов ccTLD идентичны кодам ISO 3166-1, за некоторыми заметными исключениями. Например, ccTLD Соединенного Королевства — «uk» ( .co.uk ), а его код ISO 3166-1 — «gb» (технически для субъекта «Соединенное Королевство Великобритании и Северной Ирландии»).
transitOptions optional
Тип: TransitOptions optional
Настройки, которые применяются только к запросам, в которых travelMode имеет значение TRANSIT. Этот объект не повлияет на другие режимы движения.
unitSystem optional
Тип: UnitSystem optional
По умолчанию: система единиц, используемая в стране происхождения.
Предпочтительная система единиц для использования при отображении расстояния.
waypoints optional
Тип: Array < DirectionsWaypoint > optional
Массив промежуточных путевых точек. Направления вычисляются от начала до места назначения посредством каждой путевой точки в этом массиве. См. в руководстве разработчика максимально допустимое количество путевых точек. Путевые точки не поддерживаются для маршрутов общественного транспорта. Необязательный.

Константы состояния направления

google.maps . DirectionsStatus Константы google.maps . DirectionsStatus

Статус, возвращаемый DirectionsService по завершении вызова route() . Укажите их по значению или по имени константы. Например, 'OK' или google.maps.DirectionsStatus.OK .

Получите доступ, вызвав const {DirectionsStatus} = await google.maps.importLibrary("routes") . См. Библиотеки в Maps JavaScript API .

INVALID_REQUEST Предоставленный DirectionsRequest недействителен.
MAX_WAYPOINTS_EXCEEDED В DirectionsRequest было указано слишком много DirectionsWaypoint . См. в руководстве разработчика максимально допустимое количество путевых точек.
NOT_FOUND По крайней мере один из пунктов отправления, назначения или путевых точек не может быть геокодирован.
OK Ответ содержит допустимый DirectionsResult .
OVER_QUERY_LIMIT Веб-страница превысила лимит запросов за слишком короткий период времени.
REQUEST_DENIED Веб-странице не разрешено использовать службу маршрутов.
UNKNOWN_ERROR Запрос направления не может быть обработан из-за ошибки сервера. Запрос может быть успешным, если вы попробуете еще раз.
ZERO_RESULTS Не удалось найти маршрут между пунктом отправления и пунктом назначения.

Интерфейс результатов направлений

google.maps . DirectionsResult Интерфейс google.maps . DirectionsResult

Ответ направления, полученный от сервера направлений. Вы можете визуализировать их с помощью DirectionsRenderer или проанализировать этот объект и отобразить его самостоятельно. Вы должны отображать предупреждения и информацию об авторских правах, как указано в Условиях использования платформы Google Maps . Обратите внимание, что хотя этот результат похож на JSON, он не является строго JSON, поскольку косвенно включает объекты LatLng .

routes
Тип: Array < DirectionsRoute >
Массив DirectionsRoute s, каждый из которых содержит информацию об участках и шагах, из которых он состоит. Будет только один маршрут, если DirectionsRequest не был сделан с provideRouteAlternatives для которого задано значение true .
available_travel_modes optional
Тип: Array < TravelMode > optional
Содержит множество доступных режимов движения. Это поле возвращается, когда запрос указывает режим передвижения и не дает результатов. Массив содержит доступные способы передвижения в странах заданного набора путевых точек. Это поле не возвращается, если одна или несколько путевых точек являются «через путевые точки».
geocoded_waypoints optional
Тип: Array < DirectionsGeocodedWaypoint > optional
Массив DirectionsGeocodedWaypoint s, каждый из которых содержит информацию о геокодировании начала, пункта назначения и путевых точек.

Класс DirectionsRenderer

google.maps . DirectionsRenderer Класс google.maps . DirectionsRenderer

Отображает направления, полученные от DirectionsService .

Этот класс расширяет MVCObject .

Получите доступ, вызвав const {DirectionsRenderer} = await google.maps.importLibrary("routes") . См. Библиотеки в Maps JavaScript API .

DirectionsRenderer
DirectionsRenderer([opts])
Параметры:
Создает визуализатор с заданными параметрами. Направления могут отображаться на карте (в виде визуальных наложений) или дополнительно на панели <div> (в виде текстовых инструкций).
getDirections
getDirections()
Параметры: Нет
Возвращаемое значение: DirectionsResult
Возвращает текущий набор направлений средства визуализации.
getMap
getMap()
Параметры: Нет
Возвращаемое значение: Map
Возвращает карту, на которой отображается DirectionsResult .
getPanel
getPanel()
Параметры: Нет
Возвращаемое значение: HTMLElement |null
Возвращает панель <div> , в которой отображается DirectionsResult .
getRouteIndex
getRouteIndex()
Параметры: Нет
Возвращаемое значение: number
Возвращает текущий (отсчитываемый от нуля) индекс маршрута, используемый этим объектом DirectionsRenderer .
setDirections
setDirections(directions)
Параметры:
Возвращаемое значение: нет
Настройте средство визуализации на использование результата DirectionsService . Установка допустимого набора направлений таким образом отобразит направления на назначенной карте и панели средства визуализации.
setMap
setMap(map)
Параметры:
Возвращаемое значение: нет
Этот метод указывает карту, на которой будут отображаться направления. Передайте null , чтобы удалить направления с карты.
setOptions
setOptions(options)
Параметры:
Возвращаемое значение: нет
Измените настройки параметров этого DirectionsRenderer после инициализации.
setPanel
setPanel(panel)
Параметры:
Возвращаемое значение: нет
Этот метод отображает направления в <div> . Передайте null , чтобы удалить содержимое с панели.
setRouteIndex
setRouteIndex(routeIndex)
Параметры:
  • routeIndex : number
Возвращаемое значение: нет
Задайте (отсчитываемый от нуля) индекс маршрута в объекте DirectionsResult для отображения. По умолчанию будет отображаться первый маршрут в массиве.
Унаследовано: addListener , bindTo , get , notify , set , setValues , unbind , unbindAll
directions_changed
function()
Аргументы: Нет
Это событие запускается, когда изменяются отображаемые направления, либо когда устанавливается новый DirectionsResult , либо когда пользователь завершает перетаскивание изменения пути направлений.

Интерфейс DirectionsRendererOptions

google.maps . DirectionsRendererOptions Интерфейс google.maps . DirectionsRendererOptions

Этот объект определяет свойства, которые можно задать для объекта DirectionsRenderer .

directions optional
Тип: DirectionsResult optional
Направления для отображения на карте и/или на панели <div> , полученные как объект DirectionsResult из DirectionsService .
draggable optional
Тип: boolean optional
Если true , пользователь может перетаскивать и изменять пути маршрутов, отображаемых этим DirectionsRenderer .
hideRouteList optional
Тип: boolean optional
По умолчанию: false
Это свойство указывает, должен ли модуль визуализации предоставлять выбираемый пользователем список маршрутов, отображаемых на панели маршрутов.
infoWindow optional
Тип: InfoWindow optional
InfoWindow , в котором отображается текстовая информация при щелчке маркера. Существующее содержимое информационного окна будет перезаписано, а его положение перемещено. Если информационное окно не указано, DirectionsRenderer создаст и будет использовать собственное информационное окно. Это свойство будет игнорироваться, если для параметра suppressInfoWindows задано значение true .
map optional
Тип: Map optional
Карта, на которой отображать направления.
markerOptions optional
Тип: MarkerOptions optional
Варианты маркеров. Все маркеры, отображаемые DirectionsRenderer будут использовать эти параметры.
panel optional
Тип: HTMLElement optional
<div> , в котором отображаются шаги направления.
polylineOptions optional
Тип: PolylineOptions optional
Варианты полилиний. Все полилинии, отображаемые DirectionsRenderer будут использовать эти параметры.
preserveViewport optional
Тип: boolean optional
По умолчанию: false
Если для этой опции установлено значение true или центр карты и масштаб никогда не устанавливались, входная карта центрируется и масштабируется до ограничивающей рамки этого набора направлений.
routeIndex optional
Тип: number optional
Индекс маршрута в объекте DirectionsResult . Значение по умолчанию — 0.
suppressBicyclingLayer optional
Тип: boolean optional
Подавить отрисовку BicyclingLayer , когда запрашиваются направления движения на велосипеде.
suppressInfoWindows optional
Тип: boolean optional
Подавить отображение информационных окон.
suppressMarkers optional
Тип: boolean optional
Подавить рендеринг маркеров.
suppressPolylines optional
Тип: boolean optional
Подавить визуализацию полилиний.

Интерфейс путевой точки

google.maps . DirectionsWaypoint Интерфейс google.maps . DirectionsWaypoint

DirectionsWaypoint представляет собой место между пунктом отправления и пунктом назначения, через которое должна быть проложена поездка.

location optional
Тип: string| LatLng | LatLngLiteral | Place optional
Расположение путевой точки. Может быть адресной строкой, LatLng или Place . Необязательный.
stopover optional
Тип: boolean optional
По умолчанию: true
Если true , указывает, что эта путевая точка является остановкой между пунктом отправления и пунктом назначения. Это приводит к разделению маршрута на две части. Значение false указывает на то, что маршрут должен проходить через эту путевую точку, но не должен быть разделен на две части. Это полезно, если вы хотите создать маршрут в ответ на перетаскивание пользователем путевых точек на карте.

Интерфейс DirectionsGeocodedWaypoint

google.maps . DirectionsGeocodedWaypoint Интерфейс google.maps . DirectionsGeocodedWaypoint

Единая геокодированная путевая точка.

partial_match optional
Тип: boolean optional
Не вернул ли геокодер точное совпадение с исходной путевой точкой, хотя он смог сопоставить часть запрошенного адреса.
place_id optional
Тип: string optional
Идентификатор места, связанный с путевой точкой. Идентификаторы мест однозначно идентифицируют место в базе данных Google Places и на Google Maps. Узнайте больше об идентификаторах мест в руководстве для разработчиков Places API.
types optional
Тип: Array <string> optional
Массив строк, обозначающих тип возвращенного геокодированного элемента. Список возможных строк см. в разделе «Типы адресных компонентов» Руководства разработчика.

Интерфейс Route

google.maps . DirectionsRoute Интерфейс google.maps . DirectionsRoute

Одиночный маршрут, содержащий набор участков в DirectionsResult . Обратите внимание, что хотя этот объект похож на JSON, он не является строго JSON, поскольку прямо или косвенно включает в себя объекты LatLng .

bounds
Тип: LatLngBounds
Границы этого маршрута.
copyrights
Тип: string
Текст об авторских правах, который будет отображаться для этого маршрута.
legs
Тип: Array < DirectionsLeg >
Массив DirectionsLeg s, каждый из которых содержит информацию о шагах, из которых он состоит. Для каждой указанной промежуточной точки или пункта назначения будет один этап. Таким образом, маршрут без промежуточных путевых точек будет содержать один DirectionsLeg , а маршрут с одной промежуточной путевой точкой будет содержать два.
overview_path
Тип: Array < LatLng >
Массив LatLng , представляющий весь курс этого маршрута. Путь упрощен, чтобы его можно было использовать в контекстах, где требуется небольшое количество вершин (например, URL-адреса API статических карт).
overview_polyline
Тип: string
Закодированное полилинейное представление маршрута в обзоре_пути. Эта полилиния является приблизительным (сглаженным) путем результирующих направлений.
summary
Тип: string
Содержит краткое текстовое описание маршрута, подходящее для именования и устранения неоднозначности маршрута среди альтернатив.
warnings
Тип: Array <string>
Предупреждения, которые будут отображаться при отображении этих направлений.
waypoint_order
Тип: Array <number>
Если для optimizeWaypoints установлено значение true , это поле будет содержать переупорядоченную перестановку входных путевых точек. Например, если ввод был:
Происхождение: Лос-Анджелес
Маршрутные точки: Даллас, Бангор, Феникс.
Пункт назначения: Нью-Йорк
и оптимизированный вывод был упорядочен следующим образом:
Происхождение: Лос-Анджелес
Маршрутные точки: Феникс, Даллас, Бангор
Пункт назначения: Нью-Йорк
то это поле будет Array , содержащим значения [2, 0, 1]. Обратите внимание, что нумерация путевых точек начинается с нуля.
Если для какой-либо из входных путевых точек stopover установлен в false , это поле будет пустым, так как для таких запросов оптимизация маршрута недоступна.
fare optional
Тип: TransitFare optional
Общая стоимость проезда за весь транзит. Применимо только к транзитным запросам.

Интерфейс DirectionsLeg

google.maps . DirectionsLeg Интерфейс google.maps . DirectionsLeg

Один этап, состоящий из набора шагов в DirectionsResult . Некоторые поля в ветке могут быть возвращены не для всех запросов. Обратите внимание, что хотя этот результат похож на JSON, он не является строго JSON, поскольку прямо или косвенно включает объекты LatLng .

end_address
Тип: string
Адрес пункта назначения этого этапа. Этот контент предназначен для чтения как есть. Не анализируйте программно отформатированный адрес.
end_location
Тип: LatLng
DirectionsService вычисляет маршруты между местоположениями, используя ближайший вариант транспорта (обычно дорогу) в начальном и конечном местоположениях. end_location указывает фактический геокодированный пункт назначения, который может отличаться от end_location последнего шага, если, например, дорога не находится рядом с пунктом назначения этого участка.
start_address
Тип: string
Адрес происхождения этой ноги. Этот контент предназначен для чтения как есть. Не анализируйте программно отформатированный адрес.
start_location
Тип: LatLng
DirectionsService вычисляет маршруты между местоположениями, используя ближайший вариант транспорта (обычно дорогу) в начальном и конечном местоположениях. start_location указывает фактическое геокодированное начало координат, которое может отличаться от start_location первого шага, если, например, дорога не находится рядом с началом этого участка.
steps
Тип: Array < DirectionsStep >
Массив DirectionsStep s, каждый из которых содержит информацию об отдельных шагах в этом отрезке.
traffic_speed_entry
Тип: Array <?>
Информация о скорости движения на участке.
via_waypoints
Тип: Array < LatLng >
Массив путевых точек без пересадок на этом участке, которые были указаны в исходном запросе.

Устарело в альтернативных маршрутах . Версия 3.27 будет последней версией API, которая добавляет дополнительные via_waypoints в альтернативные маршруты.

При использовании службы маршрутов для реализации перетаскиваемых маршрутов рекомендуется отключить перетаскивание альтернативных маршрутов. Только основной маршрут должен быть перетаскиваемым. Пользователи могут перетаскивать основной маршрут, пока он не совпадет с альтернативным маршрутом.

arrival_time optional
Тип: Time optional
Расчетное время прибытия на этот этап. Применимо только для ТРАНЗИТНЫХ запросов.
departure_time optional
Тип: Time optional
Расчетное время отправления для этого этапа. Применимо только для ТРАНЗИТНЫХ запросов.
distance optional
Тип: Distance optional
Общее расстояние, пройденное этим отрезком. Это свойство может быть неопределенным, так как расстояние может быть неизвестно.
duration optional
Тип: Duration optional
Общая продолжительность этого этапа. Это свойство может быть undefined , поскольку продолжительность может быть неизвестна.
duration_in_traffic optional
Тип: Duration optional
Общая продолжительность этого этапа с учетом условий трафика, указанных свойством trafficModel . Это свойство может быть undefined , поскольку продолжительность может быть неизвестна.

Интерфейс DirectionsStep

google.maps . DirectionsStep Интерфейс google.maps . DirectionsStep

Один DirectionsStep в DirectionsResult . Некоторые поля могут быть undefined . Обратите внимание, что хотя этот объект «похож на JSON», он не является строго JSON, так как напрямую включает объекты LatLng .

encoded_lat_lngs
Тип: string
Закодированное полилинейное представление шага. Это приблизительный (сглаженный) путь шага.
end_location
Тип: LatLng
Конечная точка этого шага.
end_point
Тип: LatLng
Конечная точка этого шага.
instructions
Тип: string
Инструкции для этого шага.
lat_lngs
Тип: Array < LatLng >
Последовательность LatLng , описывающая ход этого шага. Это приблизительный (сглаженный) путь шага.
maneuver
Тип: string
Содержит действие, которое нужно выполнить для текущего шага ( turn-left , merge , straight и т. д.). Значения могут быть изменены, и новые значения могут быть введены без предварительного уведомления.
path
Тип: Array < LatLng >
Последовательность LatLng , описывающая ход этого шага. Это приблизительный (сглаженный) путь шага.
start_location
Тип: LatLng
Начальное местоположение этого шага.
start_point
Тип: LatLng
Начальное местоположение этого шага.
travel_mode
Тип: TravelMode
Способ передвижения, используемый на этом этапе.
distance optional
Тип: Distance optional
Расстояние, преодолеваемое этим шагом. Это свойство может быть undefined так как расстояние может быть неизвестно.
duration optional
Тип: Duration optional
Типичное время, необходимое для выполнения этого шага, в секундах и в текстовом виде. Это свойство может быть undefined , поскольку продолжительность может быть неизвестна.
polyline optional polyline optional
Тип: DirectionsPolyline optional
Содержит объект с одним свойством «точки», который содержит закодированное полилинейное представление шага. Эта полилиния является приблизительным (сглаженным) путем ступени.
steps optional
Тип: Array < DirectionsStep > optional
Подшаги этого шага. Указывается для нетранзитных участков транзитных маршрутов.
transit optional
Тип: TransitDetails optional
Подробная информация об этом шаге, относящаяся к транзиту. Это свойство будет неопределенным, если режим передвижения на этом шаге не будет TRANSIT .
transit_details optional
Тип: TransitDetails optional
Подробности, относящиеся к этому шагу, если выбран режим передвижения TRANSIT .

Интерфейс DirectionsPolyline

google.maps . DirectionsPolyline Интерфейс google.maps . DirectionsPolyline

Объект, содержащий свойство points для описания полилинии DirectionsStep .

points
Тип: string
Закодированная полилиния .

Место интерфейса

google.maps . Place интерфейса

Содержит информацию, необходимую для поиска, идентификации или описания места для DirectionsRequest или DistanceMatrixRequest . В этом контексте «место» означает предприятие, достопримечательность или географическое положение. Для получения информации о месте см. PlacesService .

location optional
Тип: LatLng | LatLngLiteral optional
LatLng объекта, описываемого этим местом.
placeId optional
Тип: string optional
Идентификатор места (например, предприятия или достопримечательности). Идентификатор места — это уникальный идентификатор места в базе данных Google Maps. Обратите внимание, что placeId является наиболее точным способом идентификации места. По возможности следует указывать placeId , а не query . Идентификатор места можно получить из любого запроса к Places API, например из TextSearch . Идентификаторы мест также можно получить из запросов к API геокодирования. Дополнительные сведения см. в обзоре идентификаторов мест .
query optional
Тип: string optional
Поисковый запрос, описывающий место (например, компанию или достопримечательность). Пример запроса: «Набережная, верхний уровень, международный пассажирский терминал 5, Хиксон-роуд, Рокс, Новый Южный Уэльс». По возможности следует указывать placeId , а не query . API не гарантирует точность преобразования строки запроса в место. Если указаны и placeId и query , возникает ошибка.

Константы TravelMode

google.maps . TravelMode Константы google.maps . TravelMode

Допустимые режимы движения, которые можно указать в DirectionsRequest , а также режимы движения, возвращенные в DirectionsStep . Укажите их по значению или по имени константы. Например, 'BICYCLING' или google.maps.TravelMode.BICYCLING .

Получите доступ, вызвав const {TravelMode} = await google.maps.importLibrary("routes") . См. Библиотеки в Maps JavaScript API .

BICYCLING Определяет запрос велосипедных маршрутов.
DRIVING Определяет запрос направления движения.
TRANSIT Определяет запрос маршрутов общественного транспорта.
WALKING Определяет запрос пеших маршрутов.

Интерфейс параметров вождения

google.maps . DrivingOptions Интерфейс google.maps . DrivingOptions

Настраивает DirectionsRequest , когда режим движения установлен на DRIVING .

departureTime
Тип: Date
Желаемое время отправления для маршрута в виде объекта Date . Объект Date измеряет время в миллисекундах с 1 января 1970 года. Это необходимо указать, чтобы DrivingOptions был действительным. Время отправления должно быть установлено на текущее время или некоторое время в будущем. Это не может быть в прошлом.
trafficModel optional
Тип: TrafficModel optional
Предпочтительное допущение для прогнозирования продолжительности трафика. Значение по умолчанию — BEST_GUESS .

Константы TrafficModel

google.maps . TrafficModel Константы google.maps . TrafficModel

Допущения, используемые при прогнозировании продолжительности трафика. Указывается как часть DirectionsRequest или DistanceMatrixRequest . Укажите их по значению или по имени константы. Например, 'bestguess' или google.maps.TrafficModel.BEST_GUESS .

Получите доступ, вызвав const {TrafficModel} = await google.maps.importLibrary("routes") . См. Библиотеки в Maps JavaScript API .

BEST_GUESS Используйте исторические данные о трафике, чтобы лучше всего оценить время, проведенное в пробке.
OPTIMISTIC Используйте исторические данные о трафике, чтобы сделать оптимистическую оценку продолжительности трафика.
PESSIMISTIC Используйте исторические данные о трафике, чтобы сделать пессимистическую оценку продолжительности трафика.

Интерфейс TransitOptions

google.maps . TransitOptions Интерфейс google.maps . TransitOptions

Объект TransitOptions, который должен быть включен в DirectionsRequest , когда для режима передвижения задано значение TRANSIT.

arrivalTime optional
Тип: Date optional
Желаемое время прибытия для маршрута в виде объекта Date. Объект Date измеряет время в миллисекундах с 1 января 1970 года. Если указано время прибытия, время отправления игнорируется.
departureTime optional
Тип: Date optional
Желаемое время отправления для маршрута в виде объекта Date. Объект Date измеряет время в миллисекундах с 1 января 1970 года. Если ни время отправления, ни время прибытия не указаны, предполагается, что время равно «сейчас».
modes optional
Тип: Array < TransitMode > optional
Один или несколько предпочтительных видов транспорта, например, автобус или поезд. Если предпочтение не задано, API возвращает лучший маршрут по умолчанию.
routingPreference optional
Тип: TransitRoutePreference optional
Предпочтение, которое может повлиять на выбор маршрута общественного транспорта, например, меньше ходить пешком. Если предпочтение не задано, API возвращает лучший маршрут по умолчанию.

Константы TransitMode

google.maps . TransitMode Константы google.maps . TransitMode

Действительный режим транзита, например автобус, который можно указать в TransitOptions . Укажите их по значению или по имени константы. Например, 'BUS' или google.maps.TransitMode.BUS .

Получите доступ, вызвав const {TransitMode} = await google.maps.importLibrary("routes") . См. Библиотеки в Maps JavaScript API .

BUS Указывает автобус в качестве предпочтительного вида транспорта.
RAIL Указывает железную дорогу в качестве предпочтительного вида транспорта.
SUBWAY Указывает метро в качестве предпочтительного вида транспорта.
TRAIN Указывает поезд в качестве предпочтительного вида транспорта.
TRAM Указывает трамвай в качестве предпочтительного вида транспорта.

Константы TransitRoutePreference

google.maps . TransitRoutePreference Константы google.maps . TransitRoutePreference

Допустимый тип транзитного маршрута, который можно указать в TransitOptions . Укажите их по значению или по имени константы. Например, 'LESS_WALKING' или google.maps.TransitRoutePreference.LESS_WALKING .

Получите доступ, вызвав const {TransitRoutePreference} = await google.maps.importLibrary("routes") . См. Библиотеки в Maps JavaScript API .

FEWER_TRANSFERS Указывает, что рассчитанный маршрут должен предпочитать ограниченное количество пересадок.
LESS_WALKING Указывает, что рассчитанный маршрут должен предпочитать ограниченное количество пеших прогулок.

Интерфейс TransitFare

google.maps . TransitFare Интерфейс google.maps . TransitFare

Тариф DirectionsRoute , состоящий из стоимости и валюты.

currency
Тип: string
Код валюты ISO 4217 , указывающий валюту, в которой выражен тариф.
value
Тип: number
Числовое значение тарифа, выраженное в данной currency .

Интерфейс TransitDetails

google.maps . TransitDetails Интерфейс google.maps . TransitDetails

Подробная информация об отправлении, прибытии и способе транзита, использованная на этом этапе.

arrival_stop
Тип: TransitStop
Остановка прибытия этого транзитного шага.
arrival_time
Тип: Time
Время прибытия этого шага в виде объекта Time.
departure_stop
Тип: TransitStop
Остановка отправления этого транзитного шага.
departure_time
Тип: Time
Время отправления этого шага в виде объекта Time.
headsign
Тип: string
Направление движения по этой линии указано на транспортном средстве или на остановке отправления.
headway
Тип: number
Ожидаемое количество секунд между эквивалентными транспортными средствами на этой остановке.
line
Тип: TransitLine
Подробная информация о транзитной линии, используемой на этом этапе.
num_stops
Тип: number
Количество остановок на этом шаге. Включает остановку прибытия, но не остановку отправления.
trip_short_name
Тип: string
Текст, который появляется в расписаниях и на вывесках для обозначения транзитной поездки для пассажиров, например, для обозначения номеров поездов пригородных поездов. Текст однозначно идентифицирует поездку в течение служебного дня.

Интерфейс TransitStop

google.maps . TransitStop Интерфейс google.maps . TransitStop

Подробная информация о транзитной остановке или станции.

location
Тип: LatLng
Расположение этой остановки.
name
Тип: string
Название этой транзитной остановки.

Интерфейс TransitLine

google.maps . TransitLine Интерфейс google.maps . TransitLine

Информация о транзитной линии, которая обслуживает этот транзитный этап.

agencies
Тип: Array < TransitAgency >
Транзитное агентство, которое управляет этой транзитной линией.
color
Тип: string
Цвет, обычно используемый в указателях для этой линии общественного транспорта, представлен в виде шестнадцатеричной строки.
icon
Тип: string
URL-адрес значка, связанного с этой строкой.
name
Тип: string
Полное название этой линии общественного транспорта, например, «8 Avenue Local».
short_name
Тип: string
Краткое название этой линии общественного транспорта, например, "E".
text_color
Тип: string
Цвет текста, обычно используемый в указателях для этой линии общественного транспорта, представлен в виде шестнадцатеричной строки.
url
Тип: string
URL-адрес агентства, относящийся к этой линии общественного транспорта.
vehicle
Тип используемого транспортного средства, например, поезд или автобус.

Интерфейс TransitAgency

google.maps . TransitAgency Интерфейс google.maps . TransitAgency

Информация об агентстве, управляющем транзитной линией.

name
Тип: string
Название этого транзитного агентства.
phone
Тип: string
Телефон транспортной компании.
url
Тип: string
URL транспортного агентства.

Интерфейс TransitVehicle

google.maps . TransitVehicle Интерфейс google.maps . TransitVehicle

Информация о транспортном средстве, которое работает на транзитной линии.

icon
Тип: string
URL-адрес значка, который соответствует типу транспортного средства, используемого в этой строке.
local_icon
Тип: string
URL-адрес значка, который соответствует типу транспортного средства, используемого в этом регионе, вместо более общего значка.
name
Тип: string
Имя для этого типа TransitVehicle, например, «Поезд» или «Автобус».
type
Тип: VehicleType
Тип используемого транспортного средства, например, поезд, автобус или паром.

Константы типа транспортного средства

google.maps . VehicleType Константы google.maps . VehicleType

Возможные значения для типов транспортных средств.

Получите доступ, вызвав const {VehicleType} = await google.maps.importLibrary("routes") . См. Библиотеки в Maps JavaScript API .

BUS Автобус.
CABLE_CAR Транспортное средство, работающее на тросе, обычно на земле. Воздушные канатные дороги могут быть типа GONDOLA_LIFT .
COMMUTER_TRAIN Пригородная железная дорога.
FERRY Перевозить.
FUNICULAR Транспортное средство, которое поднимается по крутому склону тросом.
GONDOLA_LIFT Воздушная канатная дорога.
HEAVY_RAIL Тяжелый рельс.
HIGH_SPEED_TRAIN Высокоскоростной поезд.
INTERCITY_BUS Междугородний автобус.
METRO_RAIL Скоростной трамвай.
MONORAIL Монорельс.
OTHER Другие транспортные средства.
RAIL Железнодорожный.
SHARE_TAXI Маршрутное такси — вид автобусного транспорта с возможностью высаживать и забирать пассажиров в любом месте своего маршрута. Как правило, маршрутное такси использует микроавтобусы.
SUBWAY Подземный легкорельсовый транспорт.
TRAM Надземный легкорельсовый транспорт.
TROLLEYBUS Троллейбус.

Константы UnitSystem

google.maps . UnitSystem Константы google.maps . UnitSystem

Допустимые системы единиц измерения, которые можно указать в DirectionsRequest .

Получите доступ, вызвав const {UnitSystem} = await google.maps.importLibrary("core") . См. Библиотеки в Maps JavaScript API .

IMPERIAL Указывает, что расстояния в DirectionsResult должны быть выражены в имперских единицах.
METRIC Указывает, что расстояния в DirectionsResult должны быть выражены в метрических единицах.

Дистанционный интерфейс

google.maps . Distance интерфейс

Представление расстояния в виде числового значения и отображаемой строки.

text
Тип: string
Строковое представление значения расстояния с использованием UnitSystem , указанной в запросе.
value
Тип: number
Расстояние в метрах.

Интерфейс продолжительности

google.maps . Duration Интерфейс google.maps . Duration

Представление продолжительности в виде числового значения и отображаемой строки.

text
Тип: string
Строковое представление значения длительности.
value
Тип: number
Продолжительность в секундах.

Интерфейс времени

google.maps . Time Интерфейс google.maps . Time

Представление времени в виде объекта Date, локализованной строки и часового пояса.

text
Тип: string
Строка, представляющая значение времени. Время отображается в часовом поясе транзитной остановки.
time_zone
Тип: string
Часовой пояс, в котором находится эта остановка. Значением является название часового пояса, определенное в базе данных часовых поясов IANA, например, «Америка/Нью-Йорк».
value
Тип: Date
Время этого отправления или прибытия в виде объекта Date JavaScript.

Константы DirectionsTravelMode

google.maps . DirectionsTravelMode Константы google.maps . DirectionsTravelMode

Константы DirectionsUnitSystem

google.maps . DirectionsUnitSystem Константы google.maps . DirectionsUnitSystem

,

класс DirectionsService

google.maps . DirectionsService класс google.maps . DirectionsService

Сервис для расчета направления между двумя или более местами.

Получите доступ, вызвав const {DirectionsService} = await google.maps.importLibrary("routes") . См. Библиотеки в Maps JavaScript API .

DirectionsService
DirectionsService()
Параметры: Нет
Создает новый экземпляр DirectionsService , который отправляет запросы маршрутов на серверы Google.
route
route(request[, callback])
Параметры:
Возвращаемое значение: Promise < DirectionsResult >
Отправьте запрос на поиск маршрута.

Интерфейс DirectionsRequest

google.maps . DirectionsRequest Интерфейс google.maps . DirectionsRequest

Запрос направления, который будет отправлен в DirectionsService .

destination
Тип: string| LatLng | Place | LatLngLiteral
Место назначения. Это можно указать либо как строку для геокодирования, либо как LatLng , либо как Place . Необходимый.
origin
Тип: string| LatLng | Place | LatLngLiteral
Место происхождения. Это можно указать либо как строку для геокодирования, либо как LatLng , либо как Place . Необходимый.
travelMode
Тип: TravelMode
Запрошенный тип маршрутизации. Необходимый.
avoidFerries optional
Тип: boolean optional
Если true , служба Directions дает указание избегать паромов, где это возможно. Необязательный.
avoidHighways optional
Тип: boolean optional
Если true , служба Directions указывает, что следует по возможности избегать автомагистралей. Необязательный.
avoidTolls optional
Тип: boolean optional
Если true , служба Directions указывает, что по возможности следует избегать платных дорог. Необязательный.
drivingOptions optional
Тип: DrivingOptions optional
Настройки, которые применяются только к запросам, для которых travelMode имеет DRIVING . Этот объект не повлияет на другие режимы движения.
language optional
Тип: string optional
Идентификатор языка для языка, на котором должны быть возвращены результаты, когда это возможно. См. список поддерживаемых языков .
optimizeWaypoints optional
Тип: boolean optional
Если установлено значение true , DirectionsService попытается изменить порядок предоставленных промежуточных путевых точек, чтобы минимизировать общую стоимость маршрута. Если путевые точки оптимизированы, проверьте DirectionsRoute.waypoint_order в ответе, чтобы определить новый порядок.
provideRouteAlternatives optional
Тип: boolean optional
Должны ли быть предоставлены альтернативные маршруты. Необязательный.
region optional
Тип: string optional
Код региона, используемый в качестве смещения для запросов геокодирования. Код региона принимает двухсимвольное значение ccTLD («домен верхнего уровня») . Большинство кодов ccTLD идентичны кодам ISO 3166-1, за некоторыми заметными исключениями. Например, ccTLD Соединенного Королевства — «uk» ( .co.uk ), а его код ISO 3166-1 — «gb» (технически для субъекта «Соединенное Королевство Великобритании и Северной Ирландии»).
transitOptions optional
Тип: TransitOptions optional
Настройки, которые применяются только к запросам, в которых travelMode имеет значение TRANSIT. Этот объект не повлияет на другие режимы движения.
unitSystem optional
Тип: UnitSystem optional
По умолчанию: система единиц, используемая в стране происхождения.
Предпочтительная система единиц для использования при отображении расстояния.
waypoints optional
Тип: Array < DirectionsWaypoint > optional
Массив промежуточных путевых точек. Направления вычисляются от начала до места назначения посредством каждой путевой точки в этом массиве. См. в руководстве разработчика максимально допустимое количество путевых точек. Путевые точки не поддерживаются для маршрутов общественного транспорта. Необязательный.

Константы состояния направления

google.maps . DirectionsStatus Константы google.maps . DirectionsStatus

Статус, возвращаемый DirectionsService по завершении вызова route() . Укажите их по значению или по имени константы. Например, 'OK' или google.maps.DirectionsStatus.OK .

Получите доступ, вызвав const {DirectionsStatus} = await google.maps.importLibrary("routes") . См. Библиотеки в Maps JavaScript API .

INVALID_REQUEST Предоставленный DirectionsRequest недействителен.
MAX_WAYPOINTS_EXCEEDED В DirectionsRequest было указано слишком много DirectionsWaypoint . См. в руководстве разработчика максимально допустимое количество путевых точек.
NOT_FOUND По крайней мере один из пунктов отправления, назначения или путевых точек не может быть геокодирован.
OK Ответ содержит допустимый DirectionsResult .
OVER_QUERY_LIMIT Веб-страница превысила лимит запросов за слишком короткий период времени.
REQUEST_DENIED Веб-странице не разрешено использовать службу маршрутов.
UNKNOWN_ERROR Запрос направления не может быть обработан из-за ошибки сервера. Запрос может быть успешным, если вы попробуете еще раз.
ZERO_RESULTS Не удалось найти маршрут между пунктом отправления и пунктом назначения.

Интерфейс результатов направлений

google.maps . DirectionsResult Интерфейс google.maps . DirectionsResult

Ответ направления, полученный от сервера направлений. Вы можете визуализировать их с помощью DirectionsRenderer или проанализировать этот объект и отобразить его самостоятельно. Вы должны отображать предупреждения и информацию об авторских правах, как указано в Условиях использования платформы Google Maps . Note that though this result is "JSON-like," it is not strictly JSON, as it indirectly includes LatLng objects.

routes
An array of DirectionsRoute s, each of which contains information about the legs and steps of which it is composed. There will only be one route unless the DirectionsRequest was made with provideRouteAlternatives set to true .
available_travel_modes optional
Type: Array < TravelMode > optional
Contains an array of available travel modes. This field is returned when a request specifies a travel mode and gets no results. The array contains the available travel modes in the countries of the given set of waypoints. This field is not returned if one or more of the waypoints are 'via waypoints'.
geocoded_waypoints optional
Type: Array < DirectionsGeocodedWaypoint > optional
An array of DirectionsGeocodedWaypoint s, each of which contains information about the geocoding of origin, destination and waypoints.

DirectionsRenderer class

google.maps . DirectionsRenderer class

Renders directions obtained from the DirectionsService .

This class extends MVCObject .

Access by calling const {DirectionsRenderer} = await google.maps.importLibrary("routes") . См. Библиотеки в Maps JavaScript API .

DirectionsRenderer
DirectionsRenderer([opts])
Параметры:
Creates the renderer with the given options. Directions can be rendered on a map (as visual overlays) or additionally on a <div> panel (as textual instructions).
getDirections
getDirections()
Параметры: Нет
Return Value: DirectionsResult
Returns the renderer's current set of directions.
getMap
getMap()
Параметры: Нет
Return Value: Map
Returns the map on which the DirectionsResult is rendered.
getPanel
getPanel()
Параметры: Нет
Return Value: HTMLElement |null
Returns the panel <div> in which the DirectionsResult is rendered.
getRouteIndex
getRouteIndex()
Параметры: Нет
Return Value: number
Returns the current (zero-based) route index in use by this DirectionsRenderer object.
setDirections
setDirections(directions)
Параметры:
Return Value: None
Set the renderer to use the result from the DirectionsService . Setting a valid set of directions in this manner will display the directions on the renderer's designated map and panel.
setMap
setMap(map)
Параметры:
Return Value: None
This method specifies the map on which directions will be rendered. Pass null to remove the directions from the map.
setOptions
setOptions(options)
Параметры:
Return Value: None
Change the options settings of this DirectionsRenderer after initialization.
setPanel
setPanel(panel)
Параметры:
Return Value: None
This method renders the directions in a <div> . Pass null to remove the content from the panel.
setRouteIndex
setRouteIndex(routeIndex)
Параметры:
  • routeIndex : number
Return Value: None
Set the (zero-based) index of the route in the DirectionsResult object to render. By default, the first route in the array will be rendered.
Inherited: addListener , bindTo , get , notify , set , setValues , unbind , unbindAll
directions_changed
function()
Arguments: None
This event is fired when the rendered directions change, either when a new DirectionsResult is set or when the user finishes dragging a change to the directions path.

DirectionsRendererOptions interface

google.maps . DirectionsRendererOptions interface

This object defines the properties that can be set on a DirectionsRenderer object.

directions optional
Type: DirectionsResult optional
The directions to display on the map and/or in a <div> panel, retrieved as a DirectionsResult object from DirectionsService .
draggable optional
Type: boolean optional
If true , allows the user to drag and modify the paths of routes rendered by this DirectionsRenderer .
hideRouteList optional
Type: boolean optional
Default: false
This property indicates whether the renderer should provide a user-selectable list of routes shown in the directions panel.
infoWindow optional
Type: InfoWindow optional
The InfoWindow in which to render text information when a marker is clicked. Existing info window content will be overwritten and its position moved. If no info window is specified, the DirectionsRenderer will create and use its own info window. This property will be ignored if suppressInfoWindows is set to true .
map optional
Type: Map optional
Map on which to display the directions.
markerOptions optional
Type: MarkerOptions optional
Options for the markers. All markers rendered by the DirectionsRenderer will use these options.
panel optional
Type: HTMLElement optional
The <div> in which to display the directions steps.
polylineOptions optional
Type: PolylineOptions optional
Options for the polylines. All polylines rendered by the DirectionsRenderer will use these options.
preserveViewport optional
Type: boolean optional
Default: false
If this option is set to true or the map's center and zoom were never set, the input map is centered and zoomed to the bounding box of this set of directions.
routeIndex optional
Тип: number optional
The index of the route within the DirectionsResult object. The default value is 0.
suppressBicyclingLayer optional
Type: boolean optional
Suppress the rendering of the BicyclingLayer when bicycling directions are requested.
suppressInfoWindows optional
Type: boolean optional
Suppress the rendering of info windows.
suppressMarkers optional
Type: boolean optional
Suppress the rendering of markers.
suppressPolylines optional
Type: boolean optional
Suppress the rendering of polylines.

DirectionsWaypoint interface

google.maps . DirectionsWaypoint interface

A DirectionsWaypoint represents a location between origin and destination through which the trip should be routed.

location optional
Type: string| LatLng | LatLngLiteral | Place optional
Waypoint location. Can be an address string, a LatLng , or a Place . Optional.
stopover optional
Type: boolean optional
Default: true
If true , indicates that this waypoint is a stop between the origin and destination. This has the effect of splitting the route into two legs. If false , indicates that the route should be biased to go through this waypoint, but not split into two legs. This is useful if you want to create a route in response to the user dragging waypoints on a map.

DirectionsGeocodedWaypoint interface

google.maps . DirectionsGeocodedWaypoint interface

A single geocoded waypoint.

partial_match optional
Type: boolean optional
Whether the geocoder did not return an exact match for the original waypoint, though it was able to match part of the requested address.
place_id optional
Тип: string optional
The place ID associated with the waypoint. Place IDs uniquely identify a place in the Google Places database and on Google Maps. Learn more about Place IDs in the Places API developer guide.
types optional
Type: Array <string> optional
An array of strings denoting the type of the returned geocoded element. For a list of possible strings, refer to the Address Component Types section of the Developer's Guide.

DirectionsRoute interface

google.maps . DirectionsRoute interface

A single route containing a set of legs in a DirectionsResult . Note that though this object is "JSON-like," it is not strictly JSON, as it directly and indirectly includes LatLng objects.

bounds
The bounds for this route.
copyrights
Тип: string
Copyrights text to be displayed for this route.
legs
Type: Array < DirectionsLeg >
An array of DirectionsLeg s, each of which contains information about the steps of which it is composed. There will be one leg for each stopover waypoint or destination specified. So a route with no stopover waypoints will contain one DirectionsLeg and a route with one stopover waypoint will contain two.
overview_path
Type: Array < LatLng >
An array of LatLng s representing the entire course of this route. The path is simplified in order to make it suitable in contexts where a small number of vertices is required (such as Static Maps API URLs).
overview_polyline
Тип: string
An encoded polyline representation of the route in overview_path. This polyline is an approximate (smoothed) path of the resulting directions.
summary
Тип: string
Contains a short textual description for the route, suitable for naming and disambiguating the route from alternatives.
warnings
Type: Array <string>
Warnings to be displayed when showing these directions.
waypoint_order
Type: Array <number>
If optimizeWaypoints was set to true , this field will contain the re-ordered permutation of the input waypoints. For example, if the input was:
Origin: Los Angeles
Waypoints: Dallas, Bangor, Phoenix
Destination: New York
and the optimized output was ordered as follows:
Origin: Los Angeles
Waypoints: Phoenix, Dallas, Bangor
Destination: New York
then this field will be an Array containing the values [2, 0, 1]. Note that the numbering of waypoints is zero-based.
If any of the input waypoints has stopover set to false , this field will be empty, since route optimization is not available for such queries.
fare optional
Type: TransitFare optional
The total fare for the whole transit trip. Only applicable to transit requests.

DirectionsLeg interface

google.maps . DirectionsLeg interface

A single leg consisting of a set of steps in a DirectionsResult . Some fields in the leg may not be returned for all requests. Note that though this result is "JSON-like," it is not strictly JSON, as it directly and indirectly includes LatLng objects.

end_address
Тип: string
The address of the destination of this leg. This content is meant to be read as-is. Do not programmatically parse the formatted address.
end_location
Type: LatLng
The DirectionsService calculates directions between locations by using the nearest transportation option (usually a road) at the start and end locations. end_location indicates the actual geocoded destination, which may be different than the end_location of the last step if, for example, the road is not near the destination of this leg.
start_address
Тип: string
The address of the origin of this leg. This content is meant to be read as-is. Do not programmatically parse the formatted address.
start_location
Type: LatLng
The DirectionsService calculates directions between locations by using the nearest transportation option (usually a road) at the start and end locations. start_location indicates the actual geocoded origin, which may be different than the start_location of the first step if, for example, the road is not near the origin of this leg.
steps
An array of DirectionsStep s, each of which contains information about the individual steps in this leg.
traffic_speed_entry
Type: Array <?>
Information about traffic speed along the leg.
via_waypoints
Type: Array < LatLng >
An array of non-stopover waypoints along this leg, which were specified in the original request.

Deprecated in alternative routes . Version 3.27 will be the last version of the API that adds extra via_waypoints in alternative routes.

When using the Directions Service to implement draggable directions, it is recommended to disable dragging of alternative routes. Only the main route should be draggable. Users can drag the main route until it matches an alternative route.

arrival_time optional
Type: Time optional
An estimated arrival time for this leg. Only applicable for TRANSIT requests.
departure_time optional
Type: Time optional
An estimated departure time for this leg. Only applicable for TRANSIT requests.
distance optional
Type: Distance optional
The total distance covered by this leg. This property may be undefined as the distance may be unknown.
duration optional
Type: Duration optional
The total duration of this leg. This property may be undefined as the duration may be unknown.
duration_in_traffic optional
Type: Duration optional
The total duration of this leg, taking into account the traffic conditions indicated by the trafficModel property. This property may be undefined as the duration may be unknown.

DirectionsStep interface

google.maps . DirectionsStep interface

A single DirectionsStep in a DirectionsResult . Some fields may be undefined . Note that though this object is "JSON-like," it is not strictly JSON, as it directly includes LatLng objects.

encoded_lat_lngs
Тип: string
An encoded polyline representation of the step. This is an approximate (smoothed) path of the step.
end_location
Type: LatLng
The ending location of this step.
end_point
Type: LatLng
The ending location of this step.
instructions
Тип: string
Instructions for this step.
lat_lngs
Type: Array < LatLng >
A sequence of LatLng s describing the course of this step. This is an approximate (smoothed) path of the step.
maneuver
Тип: string
Contains the action to take for the current step ( turn-left , merge , straight , etc.). Values are subject to change, and new values may be introduced without prior notice.
path
Type: Array < LatLng >
A sequence of LatLng s describing the course of this step. This is an approximate (smoothed) path of the step.
start_location
Type: LatLng
The starting location of this step.
start_point
Type: LatLng
The starting location of this step.
travel_mode
Type: TravelMode
The mode of travel used in this step.
distance optional
Type: Distance optional
The distance covered by this step. This property may be undefined as the distance may be unknown.
duration optional
Type: Duration optional
The typical time required to perform this step in seconds and in text form. This property may be undefined as the duration may be unknown.
polyline optional polyline optional
Type: DirectionsPolyline optional
Contains an object with a single property, 'points', that holds an encoded polyline representation of the step. This polyline is an approximate (smoothed) path of the step.
steps optional
Type: Array < DirectionsStep > optional
Sub-steps of this step. Specified for non-transit sections of transit routes.
transit optional
Type: TransitDetails optional
Transit-specific details about this step. This property will be undefined unless the travel mode of this step is TRANSIT .
transit_details optional
Type: TransitDetails optional
Details pertaining to this step if the travel mode is TRANSIT .

DirectionsPolyline interface

google.maps . DirectionsPolyline interface

An object containing a points property to describe the polyline of a DirectionsStep .

points
Тип: string
An encoded polyline .

Place interface

google.maps . Place interface

Contains information needed to locate, identify, or describe a place for a DirectionsRequest or DistanceMatrixRequest . In this context, "place" means a business, point of interest, or geographic location. For fetching information about a place, see PlacesService .

location optional
Type: LatLng | LatLngLiteral optional
The LatLng of the entity described by this place.
placeId optional
Тип: string optional
The place ID of the place (such as a business or point of interest). The place ID is a unique identifier of a place in the Google Maps database. Note that the placeId is the most accurate way of identifying a place. If possible, you should specify the placeId rather than a query . A place ID can be retrieved from any request to the Places API, such as a TextSearch . Place IDs can also be retrieved from requests to the Geocoding API. For more information, see the overview of place IDs .
query optional
Тип: string optional
A search query describing the place (such as a business or point of interest). An example query is "Quay, Upper Level, Overseas Passenger Terminal 5 Hickson Road, The Rocks NSW". If possible, you should specify the placeId rather than a query . The API does not guarantee the accuracy of resolving the query string to a place. If both the placeId and query are provided, an error occurs.

TravelMode constants

google.maps . TravelMode constants

The valid travel modes that can be specified in a DirectionsRequest as well as the travel modes returned in a DirectionsStep . Specify these by value, or by using the constant's name. For example, 'BICYCLING' or google.maps.TravelMode.BICYCLING .

Access by calling const {TravelMode} = await google.maps.importLibrary("routes") . См. Библиотеки в Maps JavaScript API .

BICYCLING Specifies a bicycling directions request.
DRIVING Specifies a driving directions request.
TRANSIT Specifies a transit directions request.
WALKING Specifies a walking directions request.

DrivingOptions interface

google.maps . DrivingOptions interface

Configures the DirectionsRequest when the travel mode is set to DRIVING .

departureTime
Type: Date
The desired departure time for the route, specified as a Date object. The Date object measures time in milliseconds since 1 January 1970. This must be specified for a DrivingOptions to be valid. The departure time must be set to the current time or some time in the future. It cannot be in the past.
trafficModel optional
Type: TrafficModel optional
The preferred assumption to use when predicting duration in traffic. The default is BEST_GUESS .

TrafficModel constants

google.maps . TrafficModel constants

The assumptions to use when predicting duration in traffic. Specified as part of a DirectionsRequest or DistanceMatrixRequest . Specify these by value, or by using the constant's name. For example, 'bestguess' or google.maps.TrafficModel.BEST_GUESS .

Access by calling const {TrafficModel} = await google.maps.importLibrary("routes") . См. Библиотеки в Maps JavaScript API .

BEST_GUESS Use historical traffic data to best estimate the time spent in traffic.
OPTIMISTIC Use historical traffic data to make an optimistic estimate of what the duration in traffic will be.
PESSIMISTIC Use historical traffic data to make a pessimistic estimate of what the duration in traffic will be.

TransitOptions interface

google.maps . TransitOptions interface

The TransitOptions object to be included in a DirectionsRequest when the travel mode is set to TRANSIT.

arrivalTime optional
Type: Date optional
The desired arrival time for the route, specified as a Date object. The Date object measures time in milliseconds since 1 January 1970. If arrival time is specified, departure time is ignored.
departureTime optional
Type: Date optional
The desired departure time for the route, specified as a Date object. The Date object measures time in milliseconds since 1 January 1970. If neither departure time nor arrival time is specified, the time is assumed to be "now".
modes optional
Type: Array < TransitMode > optional
One or more preferred modes of transit, such as bus or train. If no preference is given, the API returns the default best route.
routingPreference optional
Type: TransitRoutePreference optional
A preference that can bias the choice of transit route, such as less walking. If no preference is given, the API returns the default best route.

TransitMode constants

google.maps . TransitMode constants

The valid transit mode eg bus that can be specified in a TransitOptions . Specify these by value, or by using the constant's name. For example, 'BUS' or google.maps.TransitMode.BUS .

Access by calling const {TransitMode} = await google.maps.importLibrary("routes") . См. Библиотеки в Maps JavaScript API .

BUS Specifies bus as a preferred mode of transit.
RAIL Specifies rail as a preferred mode of transit.
SUBWAY Specifies subway as a preferred mode of transit.
TRAIN Specifies train as a preferred mode of transit.
TRAM Specifies tram as a preferred mode of transit.

TransitRoutePreference constants

google.maps . TransitRoutePreference constants

The valid transit route type that can be specified in a TransitOptions . Specify these by value, or by using the constant's name. For example, 'LESS_WALKING' or google.maps.TransitRoutePreference.LESS_WALKING .

Access by calling const {TransitRoutePreference} = await google.maps.importLibrary("routes") . См. Библиотеки в Maps JavaScript API .

FEWER_TRANSFERS Specifies that the calculated route should prefer a limited number of transfers.
LESS_WALKING Specifies that the calculated route should prefer limited amounts of walking.

TransitFare interface

google.maps . TransitFare interface

A fare of a DirectionsRoute consisting of value and currency.

currency
Тип: string
An ISO 4217 currency code indicating the currency in which the fare is expressed.
value
Type: number
The numerical value of the fare, expressed in the given currency .

TransitDetails interface

google.maps . TransitDetails interface

Details about the departure, arrival, and mode of transit used in this step.

arrival_stop
The arrival stop of this transit step.
arrival_time
Type: Time
The arrival time of this step, specified as a Time object.
departure_stop
The departure stop of this transit step.
departure_time
Type: Time
The departure time of this step, specified as a Time object.
headsign
Тип: string
The direction in which to travel on this line, as it is marked on the vehicle or at the departure stop.
headway
Type: number
The expected number of seconds between equivalent vehicles at this stop.
line
Details about the transit line used in this step.
num_stops
Type: number
The number of stops on this step. Includes the arrival stop, but not the departure stop.
trip_short_name
Тип: string
The text that appears in schedules and sign boards to identify a transit trip to passengers, for example, to identify train numbers for commuter rail trips. The text uniquely identifies a trip within a service day.

TransitStop interface

google.maps . TransitStop interface

Details about a transit stop or station.

location
Type: LatLng
The location of this stop.
name
Тип: string
The name of this transit stop.

TransitLine interface

google.maps . TransitLine interface

Information about the transit line that operates this transit step.

agencies
Type: Array < TransitAgency >
The transit agency that operates this transit line.
color
Тип: string
The color commonly used in signage for this transit line, represented as a hex string.
icon
Тип: string
The URL for an icon associated with this line.
name
Тип: string
The full name of this transit line, eg "8 Avenue Local".
short_name
Тип: string
The short name of this transit line, eg "E".
text_color
Тип: string
The text color commonly used in signage for this transit line, represented as a hex string.
url
Тип: string
The agency's URL which is specific to this transit line.
vehicle
The type of vehicle used, eg train or bus.

TransitAgency interface

google.maps . TransitAgency interface

Information about an agency that operates a transit line.

name
Тип: string
The name of this transit agency.
phone
Тип: string
The transit agency's phone number.
url
Тип: string
The transit agency's URL.

TransitVehicle interface

google.maps . TransitVehicle interface

Information about the vehicle that operates on a transit line.

icon
Тип: string
A URL for an icon that corresponds to the type of vehicle used on this line.
local_icon
Тип: string
A URL for an icon that corresponds to the type of vehicle used in this region instead of the more general icon.
name
Тип: string
A name for this type of TransitVehicle, eg "Train" or "Bus".
type
The type of vehicle used, eg train, bus, or ferry.

VehicleType constants

google.maps . VehicleType constants

Possible values for vehicle types.

Access by calling const {VehicleType} = await google.maps.importLibrary("routes") . См. Библиотеки в Maps JavaScript API .

BUS Bus.
CABLE_CAR A vehicle that operates on a cable, usually on the ground. Aerial cable cars may be of the type GONDOLA_LIFT .
COMMUTER_TRAIN Commuter rail.
FERRY Ferry.
FUNICULAR A vehicle that is pulled up a steep incline by a cable.
GONDOLA_LIFT An aerial cable car.
HEAVY_RAIL Heavy rail.
HIGH_SPEED_TRAIN High speed train.
INTERCITY_BUS Intercity bus.
METRO_RAIL Light rail.
MONORAIL Monorail.
OTHER Other vehicles.
RAIL Rail.
SHARE_TAXI Share taxi is a sort of bus transport with ability to drop off and pick up passengers anywhere on its route. Generally share taxi uses minibus vehicles.
SUBWAY Underground light rail.
TRAM Above ground light rail.
TROLLEYBUS Trolleybus.

UnitSystem constants

google.maps . UnitSystem constants

The valid unit systems that can be specified in a DirectionsRequest .

Access by calling const {UnitSystem} = await google.maps.importLibrary("core") . См. Библиотеки в Maps JavaScript API .

IMPERIAL Specifies that distances in the DirectionsResult should be expressed in imperial units.
METRIC Specifies that distances in the DirectionsResult should be expressed in metric units.

Distance interface

google.maps . Distance interface

A representation of distance as a numeric value and a display string.

text
Тип: string
A string representation of the distance value, using the UnitSystem specified in the request.
value
Type: number
The distance in meters.

Duration interface

google.maps . Duration interface

A representation of duration as a numeric value and a display string.

text
Тип: string
A string representation of the duration value.
value
Type: number
The duration in seconds.

Time interface

google.maps . Time interface

A representation of time as a Date object, a localized string, and a time zone.

text
Тип: string
A string representing the time's value. The time is displayed in the time zone of the transit stop.
time_zone
Тип: string
The time zone in which this stop lies. The value is the name of the time zone as defined in the IANA Time Zone Database, eg "America/New_York".
value
Type: Date
The time of this departure or arrival, specified as a JavaScript Date object.

DirectionsTravelMode constants

google.maps . DirectionsTravelMode constants

DirectionsUnitSystem constants

google.maps . DirectionsUnitSystem constants