Класс JourneySharingMapView
google.maps.journeySharing.JourneySharingMapView
библиотека
класса "journeySharing"
Карта.
const {JourneySharingMapView} = await google.maps.importLibrary("journeySharing");
Конструктор | |
|---|---|
JourneySharingMapView |
JourneySharingMapView(options)Параметры:
Создает экземпляр представления карты. |
Свойства | |
|---|---|
automaticViewportMode |
Это поле доступно только для чтения. Автоматический режим области просмотра. |
element |
Тип:
ElementЭто поле доступно только для чтения. Элемент DOM, поддерживающий представление. |
enableTraffic |
Тип:
booleanВключает или отключает слой загруженности дорог. |
locationProviders |
Тип:
Array<LocationProvider> optionalЭто поле доступно только для чтения. Источники отслеживаемых местоположений, которые будут показаны на карте. Чтобы добавить или удалить поставщиков геоданных, используйте методы JourneySharingMapView.addLocationProvider и JourneySharingMapView.removeLocationProvider. |
map |
Тип:
MapЭто поле доступно только для чтения. Объект карты, содержащийся в представлении карты. |
mapOptions |
Тип:
MapOptionsЭто поле доступно только для чтения. Параметры карты, передаваемые в нее через представление карты. |
|
Тип:
LocationProvider optionalЭто поле доступно только для чтения. Источник отслеживаемых местоположений, которые будут показаны на карте отслеживания. |
|
Тип:
MarkerSetupНастраивает параметры маркера местоположения пункта назначения. Вызывается при отрисовке нового маркера пункта назначения. Если вы указываете функцию, она может и должна изменить поле defaultMarkerOptions входных данных, содержащее объект google.maps.MarkerOptions, и вернуть его как markerOptions в выходном объекте MarkerSetupOptions. Указание объекта MarkerSetupOptions дает тот же эффект, что и указание функции, которая возвращает этот статический объект. Не используйте один и тот же объект MarkerSetupOptions в разных функциях MarkerSetup или статических значениях, а также один и тот же объект google.maps.MarkerOptions для ключа markerOptions в разных объектах MarkerSetupOptions. Если markerOptions не задан или имеет значение null, он будет перезаписан значением по умолчанию. Любое значение, заданное для markerOptions.map или markerOptions.position, будет игнорироваться. |
|
Тип:
MarkerSetupНастраивает параметры маркера начального местоположения. Вызывается при отрисовке нового маркера отправления. Если вы указываете функцию, она может и должна изменить поле defaultMarkerOptions входных данных, содержащее объект google.maps.MarkerOptions, и вернуть его как markerOptions в выходном объекте MarkerSetupOptions. Указание объекта MarkerSetupOptions дает тот же результат, что и указание функции, которая возвращает этот статический объект. Не используйте один и тот же объект MarkerSetupOptions в разных функциях MarkerSetup или статических значениях, а также один и тот же объект google.maps.MarkerOptions для ключа markerOptions в разных объектах MarkerSetupOptions. Если markerOptions не задан или имеет значение null, он будет перезаписан значением по умолчанию. Любое значение, заданное для markerOptions.map или markerOptions.position, будет игнорироваться. |
|
Тип:
MarkerSetupНастраивает параметры маркера местоположения результата задачи. Вызывается при отрисовке нового маркера местоположения результата задачи. Если вы указываете функцию, она может и должна изменить поле defaultMarkerOptions входных данных, содержащее объект google.maps.MarkerOptions, и вернуть его как markerOptions в выходном объекте MarkerSetupOptions. Указание объекта MarkerSetupOptions дает тот же результат, что и указание функции, которая возвращает этот статический объект. Не используйте один и тот же объект MarkerSetupOptions в разных функциях MarkerSetup или статических значениях, а также один и тот же объект google.maps.MarkerOptions для ключа markerOptions в разных объектах MarkerSetupOptions. Если markerOptions не задан или имеет значение null, он будет перезаписан значением по умолчанию. Любое значение, заданное для markerOptions.map или markerOptions.position, будет игнорироваться. |
|
Тип:
MarkerSetupНастраивает параметры маркера местоположения для невыполненной задачи. Вызывается при отрисовке нового маркера неудачной задачи. Если вы указываете функцию, она может и должна изменить поле defaultMarkerOptions входных данных, содержащее объект google.maps.MarkerOptions, и вернуть его как markerOptions в выходном объекте MarkerSetupOptions. Указание объекта MarkerSetupOptions дает тот же эффект, что и указание функции, которая возвращает этот статический объект. Не используйте один и тот же объект MarkerSetupOptions в разных функциях MarkerSetup или статических значениях, а также один и тот же объект google.maps.MarkerOptions для ключа markerOptions в разных объектах MarkerSetupOptions. Если markerOptions не задан или имеет значение null, он будет перезаписан значением по умолчанию. Любое значение, заданное для markerOptions.map или markerOptions.position, будет игнорироваться. |
|
Тип:
MarkerSetupНастраивает параметры маркера местоположения транспортного средства. Вызывается при отрисовке нового маркера транспортного средства. Если вы указываете функцию, она может и должна изменить поле defaultMarkerOptions входных данных, содержащее объект google.maps.MarkerOptions, и вернуть его как markerOptions в выходном объекте MarkerSetupOptions. Указание объекта MarkerSetupOptions дает тот же эффект, что и указание функции, которая возвращает этот статический объект. Не используйте один и тот же объект MarkerSetupOptions в разных функциях MarkerSetup или статических значениях, а также один и тот же объект google.maps.MarkerOptions для ключа markerOptions в разных объектах MarkerSetupOptions. Если markerOptions не задан или имеет значение null, он будет перезаписан значением по умолчанию. Любое значение, заданное для markerOptions.map или markerOptions.position, будет игнорироваться. |
|
Тип:
MarkerSetupНастраивает параметры маркера местоположения путевой точки. Вызывается при отрисовке нового маркера путевой точки. Если вы указываете функцию, она может и должна изменить поле defaultMarkerOptions входных данных, содержащее объект google.maps.MarkerOptions, и вернуть его как markerOptions в выходном объекте MarkerSetupOptions. Указание объекта MarkerSetupOptions дает тот же эффект, что и указание функции, которая возвращает этот статический объект. Не используйте один и тот же объект MarkerSetupOptions в разных функциях MarkerSetup или статических значениях, а также один и тот же объект google.maps.MarkerOptions для ключа markerOptions в разных объектах MarkerSetupOptions. Если markerOptions не задан или имеет значение null, он будет перезаписан значением по умолчанию. Любое значение, заданное для markerOptions.map или markerOptions.position, будет игнорироваться. |
|
Тип:
PolylineSetupНастраивает параметры для ломаной линии ожидаемого маршрута. Вызывается при отрисовке новой ломаной линии ожидаемого маршрута. Если вы указываете функцию, она может и должна изменять поле defaultPolylineOptions входных данных, содержащее объект google.maps.PolylineOptions, и возвращать его как polylineOptions в выходном объекте PolylineSetupOptions. Указание объекта PolylineSetupOptions имеет тот же эффект, что и указание функции, которая возвращает этот статический объект. Не используйте один и тот же объект PolylineSetupOptions в разных функциях PolylineSetup или статических значениях, а также один и тот же объект google.maps.PolylineOptions для ключа polylineOptions в разных объектах PolylineSetupOptions. Если polylineOptions или visible не заданы или имеют значение null, они будут перезаписаны значениями по умолчанию. Все значения, заданные для polylineOptions.map или polylineOptions.path, будут игнорироваться. |
|
Тип:
PolylineSetupНастраивает параметры для ломаной линии пройденного маршрута. Вызывается при отрисовке новой ломаной линии пройденного маршрута. Если вы указываете функцию, она может и должна изменять поле defaultPolylineOptions входных данных, содержащее объект google.maps.PolylineOptions, и возвращать его как polylineOptions в выходном объекте PolylineSetupOptions. Указание объекта PolylineSetupOptions имеет тот же эффект, что и указание функции, которая возвращает этот статический объект. Не используйте один и тот же объект PolylineSetupOptions в разных функциях PolylineSetup или статических значениях, а также один и тот же объект google.maps.PolylineOptions для ключа polylineOptions в разных объектах PolylineSetupOptions. Любые значения, заданные для polylineOptions.map или polylineOptions.path, будут игнорироваться. Любое незаданное или нулевое значение будет перезаписано значением по умолчанию. |
|
Тип:
MarkerSetupНастраивает параметры маркера местоположения. Вызывается при отрисовке нового маркера пинга. Если вы указываете функцию, она может и должна изменить поле defaultMarkerOptions входных данных, содержащее объект google.maps.MarkerOptions, и вернуть его как markerOptions в выходном объекте MarkerSetupOptions. Указание объекта MarkerSetupOptions дает тот же результат, что и указание функции, которая возвращает этот статический объект. Не используйте один и тот же объект MarkerSetupOptions в разных функциях MarkerSetup или статических значениях, а также один и тот же объект google.maps.MarkerOptions для ключа markerOptions в разных объектах MarkerSetupOptions. Если markerOptions не задан или имеет значение null, он будет перезаписан значением по умолчанию. Любое значение, заданное для markerOptions.map или markerOptions.position, будет игнорироваться. |
|
Тип:
MarkerSetupНастраивает параметры маркера местоположения для успешно выполненной задачи. Вызывается при отрисовке нового маркера успешно выполненной задачи. Если вы указываете функцию, она может и должна изменить поле defaultMarkerOptions входных данных, содержащее объект google.maps.MarkerOptions, и вернуть его как markerOptions в выходном объекте MarkerSetupOptions. Указание объекта MarkerSetupOptions дает тот же результат, что и указание функции, которая возвращает этот статический объект. Не используйте один и тот же объект MarkerSetupOptions в разных функциях MarkerSetup или статических значениях, а также один и тот же объект google.maps.MarkerOptions для ключа markerOptions в разных объектах MarkerSetupOptions. Если markerOptions не задан или имеет значение null, он будет перезаписан значением по умолчанию. Любое значение, заданное для markerOptions.map или markerOptions.position, будет игнорироваться. |
|
Возвращает маркеры пунктов назначения, если они есть. |
|
Возвращает маркеры начальной точки, если они есть. |
|
Возвращает маркеры успешно выполненных задач, если они есть. |
|
Возвращает маркеры результатов задачи, если они есть. |
|
Возвращает маркеры неудачных задач, если они есть. |
|
Возвращает маркеры транспортных средств, если они есть. |
|
Возвращает маркеры путевых точек, если они есть. |
|
Возвращает ломаные линии ожидаемого маршрута, если они есть. |
|
Возвращает ломаные линии пройденного маршрута, если они есть. |
Методы | |
|---|---|
addLocationProvider |
addLocationProvider(locationProvider)Параметры:
Возвращаемое значение: нет.
Добавляет поставщика данных о местоположении в представление карты. Если поставщик уже добавлен, ничего не произойдет. |
removeLocationProvider |
removeLocationProvider(locationProvider)Параметры:
Возвращаемое значение: нет.
Удаляет поставщика данных о местоположении из представления карты. Если поставщик местоположения ещё не добавлен в представление карты, никаких действий не выполняется. |
Интерфейс JourneySharingMapViewOptions
google.maps.journeySharing.JourneySharingMapViewOptions
интерфейс
Параметры для просмотра карты.
Свойства | |
|---|---|
element |
Тип:
ElementЭлемент DOM, поддерживающий представление. Обязательно. |
необязательно |
Тип:
PolylineSetup optionalНастраивает параметры для ломаной линии ожидаемого маршрута. Вызывается при отрисовке новой ломаной линии ожидаемого маршрута. Если вы указываете функцию, она может и должна изменять поле defaultPolylineOptions входных данных, содержащее объект google.maps.PolylineOptions, и возвращать его как polylineOptions в выходном объекте PolylineSetupOptions. Указание объекта PolylineSetupOptions имеет тот же эффект, что и указание функции, которая возвращает этот статический объект. Не используйте один и тот же объект PolylineSetupOptions в разных функциях PolylineSetup или статических значениях, а также один и тот же объект google.maps.PolylineOptions для ключа polylineOptions в разных объектах PolylineSetupOptions. Если polylineOptions или visible не заданы или имеют значение null, они будут перезаписаны значением по умолчанию. Все значения, заданные для polylineOptions.map или polylineOptions.path, будут игнорироваться. |
automaticViewportMode
необязательно |
Тип:
AutomaticViewportMode optionalАвтоматический режим области просмотра. Значение по умолчанию – FIT_ANTICIPATED_ROUTE. Оно позволяет автоматически настраивать область просмотра карты так, чтобы в нее помещались маркеры транспортных средств, маркеры местоположений и все видимые ломаные линии ожидаемого маршрута. Чтобы отключить автоматическую подгонку, выберите NONE. |
необязательно |
Тип:
MarkerSetup optionalНастраивает параметры маркера местоположения пункта назначения. Вызывается при отрисовке нового маркера пункта назначения. Если вы указываете функцию, она может и должна изменить поле defaultMarkerOptions входных данных, содержащее объект google.maps.MarkerOptions, и вернуть его как markerOptions в выходном объекте MarkerSetupOptions. Указание объекта MarkerSetupOptions дает тот же результат, что и указание функции, которая возвращает этот статический объект. Не используйте один и тот же объект MarkerSetupOptions в разных функциях MarkerSetup или статических значениях, а также один и тот же объект google.maps.MarkerOptions для ключа markerOptions в разных объектах MarkerSetupOptions. Если markerOptions не задан или имеет значение null, он будет перезаписан значением по умолчанию. Любое значение, заданное для markerOptions.map или markerOptions.position, будет игнорироваться. |
необязательно |
Тип:
LocationProvider optionalИсточник отслеживаемых местоположений, которые будут показаны на карте отслеживания. Необязательное поле. |
locationProviders
необязательно |
Тип:
Array<LocationProvider> optionalИсточники отслеживаемых местоположений, которые будут показаны на карте. Необязательное поле. |
mapOptions
необязательно |
Тип:
MapOptions optionalПараметры карты, передаваемые в конструктор google.maps.Map. |
необязательно |
Тип:
MarkerSetup optionalНастраивает параметры маркера начального местоположения. Вызывается при отрисовке нового маркера отправления. Если вы указываете функцию, она может и должна изменить поле defaultMarkerOptions входных данных, содержащее объект google.maps.MarkerOptions, и вернуть его как markerOptions в выходном объекте MarkerSetupOptions. Указание объекта MarkerSetupOptions дает тот же эффект, что и указание функции, которая возвращает этот статический объект. Не используйте один и тот же объект MarkerSetupOptions в разных функциях MarkerSetup или статических значениях, а также один и тот же объект google.maps.MarkerOptions для ключа markerOptions в разных объектах MarkerSetupOptions. Если markerOptions не задан или имеет значение null, он будет перезаписан значением по умолчанию. Любое значение, заданное для markerOptions.map или markerOptions.position, будет игнорироваться. |
необязательно |
Тип:
MarkerSetup optionalНастраивает параметры маркера местоположения. Вызывается при отрисовке нового маркера пинга. Если вы указываете функцию, она может и должна изменять поле defaultMarkerOptions входных данных, содержащее объект google.maps.MarkerOptions, и возвращать его как markerOptions в выходном объекте MarkerSetupOptions. Указание объекта MarkerSetupOptions дает тот же результат, что и указание функции, которая возвращает этот статический объект. Не используйте один и тот же объект MarkerSetupOptions в разных функциях MarkerSetup или статических значениях, а также один и тот же объект google.maps.MarkerOptions для ключа markerOptions в разных объектах MarkerSetupOptions. Если markerOptions не задан или имеет значение null, он будет перезаписан значением по умолчанию. Любое значение, заданное для markerOptions.map или markerOptions.position, будет игнорироваться. |
необязательно |
Тип:
MarkerSetup optionalНастраивает параметры маркера местоположения для успешно выполненной задачи. Вызывается при отрисовке нового маркера успешно выполненной задачи. Если вы указываете функцию, она может и должна изменить поле defaultMarkerOptions входных данных, содержащее объект google.maps.MarkerOptions, и вернуть его как markerOptions в выходном объекте MarkerSetupOptions. Указание объекта MarkerSetupOptions дает тот же результат, что и указание функции, которая возвращает этот статический объект. Не используйте один и тот же объект MarkerSetupOptions в разных функциях MarkerSetup или статических значениях, а также один и тот же объект google.maps.MarkerOptions для ключа markerOptions в разных объектах MarkerSetupOptions. Если markerOptions не задан или имеет значение null, он будет перезаписан значением по умолчанию. Любое значение, заданное для markerOptions.map или markerOptions.position, будет игнорироваться. |
необязательно |
Тип:
PolylineSetup optionalНастраивает параметры для ломаной линии пройденного маршрута. Вызывается при отрисовке новой ломаной линии пройденного маршрута. Если вы указываете функцию, она может и должна изменять поле defaultPolylineOptions входных данных, содержащее объект google.maps.PolylineOptions, и возвращать его как polylineOptions в выходном объекте PolylineSetupOptions. Указание объекта PolylineSetupOptions имеет тот же эффект, что и указание функции, которая возвращает этот статический объект. Не используйте один и тот же объект PolylineSetupOptions в разных функциях PolylineSetup или статических значениях, а также один и тот же объект google.maps.PolylineOptions для ключа polylineOptions в разных объектах PolylineSetupOptions. Любые значения, заданные для polylineOptions.map или polylineOptions.path, будут игнорироваться. Любое незаданное или нулевое значение будет перезаписано значением по умолчанию. |
необязательно |
Тип:
MarkerSetup optionalНастраивает параметры маркера местоположения результата задачи. Вызывается при отрисовке нового маркера местоположения результата задачи. Если вы указываете функцию, она может и должна изменить поле defaultMarkerOptions входных данных, содержащее объект google.maps.MarkerOptions, и вернуть его как markerOptions в выходном объекте MarkerSetupOptions. Указание объекта MarkerSetupOptions дает тот же результат, что и указание функции, которая возвращает этот статический объект. Не используйте один и тот же объект MarkerSetupOptions в разных функциях MarkerSetup или статических значениях, а также один и тот же объект google.maps.MarkerOptions для ключа markerOptions в разных объектах MarkerSetupOptions. Если markerOptions не задан или имеет значение null, он будет перезаписан значением по умолчанию. Любое значение, заданное для markerOptions.map или markerOptions.position, будет игнорироваться. |
необязательно |
Тип:
MarkerSetup optionalНастраивает параметры маркера местоположения для невыполненной задачи. Вызывается при отрисовке нового маркера неудачной задачи. Если вы указываете функцию, она может и должна изменить поле defaultMarkerOptions входных данных, содержащее объект google.maps.MarkerOptions, и вернуть его как markerOptions в выходном объекте MarkerSetupOptions. Указание объекта MarkerSetupOptions дает тот же результат, что и указание функции, которая возвращает этот статический объект. Не используйте один и тот же объект MarkerSetupOptions в разных функциях MarkerSetup или статических значениях, а также один и тот же объект google.maps.MarkerOptions для ключа markerOptions в разных объектах MarkerSetupOptions. Если markerOptions не задан или имеет значение null, он будет перезаписан значением по умолчанию. Любое значение, заданное для markerOptions.map или markerOptions.position, будет игнорироваться. |
необязательно |
Тип:
MarkerSetup optionalНастраивает параметры маркера местоположения транспортного средства. Вызывается при отрисовке нового маркера транспортного средства. Если вы указываете функцию, она может и должна изменить поле defaultMarkerOptions входных данных, содержащее объект google.maps.MarkerOptions, и вернуть его как markerOptions в выходном объекте MarkerSetupOptions. Указание объекта MarkerSetupOptions дает тот же результат, что и указание функции, которая возвращает этот статический объект. Не используйте один и тот же объект MarkerSetupOptions в разных функциях MarkerSetup или статических значениях, а также один и тот же объект google.maps.MarkerOptions для ключа markerOptions в разных объектах MarkerSetupOptions. Если markerOptions не задан или имеет значение null, он будет перезаписан значением по умолчанию. Любое значение, заданное для markerOptions.map или markerOptions.position, будет игнорироваться. |
необязательно |
Тип:
MarkerSetup optionalНастраивает параметры маркера местоположения путевой точки. Вызывается при отрисовке нового маркера путевой точки. Если вы указываете функцию, она может и должна изменить поле defaultMarkerOptions входных данных, содержащее объект google.maps.MarkerOptions, и вернуть его как markerOptions в выходном объекте MarkerSetupOptions. Указание объекта MarkerSetupOptions дает тот же результат, что и указание функции, которая возвращает этот статический объект. Не используйте один и тот же объект MarkerSetupOptions в разных функциях MarkerSetup или статических значениях, а также один и тот же объект google.maps.MarkerOptions для ключа markerOptions в разных объектах MarkerSetupOptions. Если markerOptions не задан или имеет значение null, он будет перезаписан значением по умолчанию. Любое значение, заданное для markerOptions.map или markerOptions.position, будет игнорироваться. |
Константы AutomaticViewportMode
google.maps.journeySharing.AutomaticViewportMode
Библиотека
констант
"journeySharing"
Автоматический режим области просмотра.
Эти константы также можно использовать в качестве строк. В TypeScript строковые литералы определяются типом AutomaticViewportModeString.
const {AutomaticViewportMode} = await google.maps.importLibrary("journeySharing");
Константы | |
|---|---|
FIT_ANTICIPATED_ROUTE |
Автоматически настраивать область просмотра, чтобы в нее помещались маркеры и все видимые ломаные линии ожидаемого маршрута. Это значение используется по умолчанию. |
NONE |
Не выполнять автоматическую корректировку области просмотра. |
Абстрактный класс LocationProvider
google.maps.journeySharing.LocationProvider
абстрактный класс
Родительский класс всех поставщиков данных о местоположении.
Методы | |
|---|---|
addListener |
addListener(eventName, handler)Параметры:
Возвращаемое значение:
MapsEventListenerДобавляет MapsEventListener для события, активированного этим поставщиком данных о местоположении. Возвращает идентификатор для этого прослушивателя, который можно использовать с event.removeListener. |
Абстрактный класс PollingLocationProvider
google.maps.journeySharing.PollingLocationProvider
abstract class
extends LocationProvider
Родительский класс поставщиков избирательных участков.
Свойства | |
|---|---|
isPolling |
Тип:
booleanTrue, если этот поставщик данных о местоположении выполняет опрос. Только для чтения. |
pollingIntervalMillis |
Тип:
numberМинимальное время между получением обновлений местоположения в миллисекундах. Если на получение данных о местоположении уходит больше pollingIntervalMillis, следующее обновление не начнется, пока не завершится текущее. Если задать значение 0, Infinity или отрицательное значение, автоматическое обновление местоположения будет отключено. Новое уведомление о местоположении запрашивается один раз, если изменяется параметр идентификатора отслеживания (например, идентификатор отслеживания отправления поставщика данных о местоположении отправления) или параметр фильтрации (например, границы области просмотра или фильтры атрибутов для поставщиков данных о местоположении автопарка). По умолчанию интервал опроса составляет 5000 миллисекунд. Это минимальное значение. Если вы установите меньшее положительное значение, будет сохранено и использовано значение 5000. |
Методы | |
|---|---|
Унаследованные:
addListener
|
События | |
|---|---|
ispollingchange |
function(event)Аргументы:
Событие, которое активируется при обновлении состояния опроса поставщика данных о местоположении. Используйте PollingLocationProvider.isPolling, чтобы определить текущее состояние опроса. |
Интерфейс PollingLocationProviderIsPollingChangeEvent
google.maps.journeySharing.PollingLocationProviderIsPollingChangeEvent
интерфейс
Объект события, передаваемый обработчику событий при активации события PollingLocationProvider.ispollingchange.
Свойства | |
|---|---|
error
необязательно |
Тип:
Error optionalОшибка, которая привела к изменению статуса опроса, если изменение было вызвано ошибкой. Не определено, если изменение статуса произошло в результате обычных операций. |