Trip and Order Progress

Класс FleetEngineTripLocationProvider

class google.maps.journeySharing.FleetEngineTripLocationProvider extends PollingLocationProvider, LocationProvider
library "journeySharing"

Поставщик данных о местоположении для поездки.

const {FleetEngineTripLocationProvider} = await google.maps.importLibrary("journeySharing");
FleetEngineTripLocationProvider
FleetEngineTripLocationProvider(options)
Параметры:
Создает нового поставщика местоположения для поездки Fleet Engine.
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION(params)
Параметры:
Возвращаемое значение: нет.
Функция настройки ломаной линии, которая окрашивает активную ломаную линию в соответствии с показаниями скорости. Укажите эту функцию в качестве FleetEngineTripLocationProviderOptions.activePolylineCustomization, чтобы отобразить ломаную линию с учетом трафика для активной ломаной линии.
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION(params)
Параметры:
Возвращаемое значение: нет.
Функция настройки ломаной линии, которая окрашивает оставшуюся часть ломаной линии в соответствии с показаниями скорости. Укажите эту функцию в качестве FleetEngineTripLocationProviderOptions.remainingPolylineCustomization, чтобы отрисовать ломаную линию с учетом трафика для оставшейся части маршрута.
tripId
Тип: string
Идентификатор рейса, который отслеживает этот поставщик данных о местоположении. Чтобы начать отслеживание, задайте значение этого поля.
Унаследованные: isPolling, pollingIntervalMillis
refresh
refresh()
Параметры: нет.
Возвращаемое значение: void
Явно обновляет отслеживаемое местоположение.
Унаследованные: addListener
error
function(event)
Аргументы:
Событие, которое активируется, когда поставщик данных о местоположении сталкивается с ошибкой.
update
function(event)
Аргументы:
Событие, которое активируется, когда запрос на обновление данных Fleet Engine завершен.
Унаследованные: ispollingchange

Интерфейс FleetEngineTripLocationProviderOptions

интерфейс google.maps.journeySharing.FleetEngineTripLocationProviderOptions

Параметры поставщика данных о местоположении для поездки.

authTokenFetcher
Предоставляет веб-токены JSON для аутентификации клиента в Fleet Engine.
projectId
Тип: string
Идентификатор проекта клиента из консоли Google Cloud.
activePolylineCustomization
необязательно
Тип: (function(TripPolylineCustomizationFunctionParams): void)|PolylineOptions optional
Настройки, примененные к активной ломаной линии. Активная ломаная линия соответствует части маршрута, по которой в данный момент движется транспортное средство.

Используйте это поле, чтобы задать собственный стиль (например, цвет ломаной линии) и интерактивность (например, обработку кликов).
  • Если указан объект PolylineOptions, то заданные в нем изменения применяются к ломаной линии после ее создания, перезаписывая ее параметры по умолчанию, если они есть.
  • Если указана функция, она вызывается один раз при создании ломаной линии. (При этом вызове параметр isNew в объекте параметров функции имеет значение true). Кроме того, эта функция вызывается, когда меняются координаты ломаной линии или когда поставщик данных о местоположении получает данные от Fleet Engine, независимо от того, изменились ли данные, соответствующие этой ломаной линии.

    Список предоставленных параметров и их использование приведены в TripPolylineCustomizationFunctionParams.
destinationMarkerCustomization
необязательно
Тип: (function(TripMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Настройки, примененные к маркеру пункта назначения.

Используйте это поле, чтобы задать собственный стиль (например, значок маркера) и интерактивность (например, обработку кликов).
  • Если указан объект MarkerOptions, то после создания маркера к нему применяются изменения, указанные в этом объекте, и перезаписываются параметры по умолчанию, если они есть.
  • Если указана функция, она вызывается один раз при создании маркера, прежде чем он будет добавлен в представление карты. При этом вызове параметр isNew в объекте параметров функции имеет значение true. Кроме того, эта функция вызывается, когда поставщик данных о местоположении получает данные от Fleet Engine, независимо от того, изменились ли данные, соответствующие этому маркеру.

    Список предоставленных параметров и их использование см. в TripMarkerCustomizationFunctionParams.
originMarkerCustomization
необязательно
Тип: (function(TripMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Настройки, примененные к маркеру отправления.

Используйте это поле, чтобы задать собственный стиль (например, значок маркера) и интерактивность (например, обработку кликов).
  • Если указан объект MarkerOptions, то после создания маркера к нему применяются изменения, указанные в этом объекте, и перезаписываются параметры по умолчанию, если они есть.
  • Если указана функция, она вызывается один раз при создании маркера, прежде чем он будет добавлен в представление карты. При этом вызове параметр isNew в объекте параметров функции имеет значение true. Кроме того, эта функция вызывается, когда поставщик данных о местоположении получает данные от Fleet Engine, независимо от того, изменились ли данные, соответствующие этому маркеру.

    Список предоставленных параметров и их использование см. в TripMarkerCustomizationFunctionParams.
pollingIntervalMillis
необязательно
Тип: number optional
Минимальное время между получением обновлений местоположения в миллисекундах. Если на получение данных о местоположении уходит больше pollingIntervalMillis, следующее обновление не начнется, пока не завершится текущее.

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

По умолчанию интервал опроса составляет 5000 миллисекунд (минимальное значение). Если вы установите меньшее ненулевое значение, будет использоваться 5000.
remainingPolylineCustomization
необязательно
Тип: (function(TripPolylineCustomizationFunctionParams): void)|PolylineOptions optional
Настройки применены к оставшейся части ломаной линии. Оставшаяся ломаная линия соответствует части маршрута, которую транспортное средство ещё не начало проходить.

Используйте это поле, чтобы задать собственный стиль (например, цвет ломаной линии) и интерактивность (например, обработку кликов).
  • Если указан объект PolylineOptions, то заданные в нем изменения применяются к ломаной линии после ее создания, перезаписывая ее параметры по умолчанию, если они есть.
  • Если указана функция, она вызывается один раз при создании ломаной линии. (При этом вызове параметр isNew в объекте параметров функции имеет значение true). Кроме того, эта функция вызывается, когда меняются координаты ломаной линии или когда поставщик данных о местоположении получает данные от Fleet Engine, независимо от того, изменились ли данные, соответствующие этой ломаной линии.

    Список предоставленных параметров и их использование приведены в TripPolylineCustomizationFunctionParams.
takenPolylineCustomization
необязательно
Тип: (function(TripPolylineCustomizationFunctionParams): void)|PolylineOptions optional
Настройки, примененные к выбранной ломаной линии. Пройденная ломаная линия соответствует части маршрута, которую транспортное средство уже преодолело.

Используйте это поле, чтобы задать собственный стиль (например, цвет ломаной линии) и интерактивность (например, обработку кликов).
  • Если указан объект PolylineOptions, то заданные в нем изменения применяются к ломаной линии после ее создания, перезаписывая ее параметры по умолчанию, если они есть.
  • Если указана функция, она вызывается один раз при создании ломаной линии. (При этом вызове параметр isNew в объекте параметров функции имеет значение true). Кроме того, эта функция вызывается, когда меняются координаты ломаной линии или когда поставщик данных о местоположении получает данные от Fleet Engine, независимо от того, изменились ли данные, соответствующие этой ломаной линии.

    Список предоставленных параметров и их использование приведены в TripPolylineCustomizationFunctionParams.
tripId
необязательно
Тип: string optional
Идентификатор поездки, который нужно отслеживать сразу после создания экземпляра поставщика данных о местоположении. Если идентификатор не указан, поставщик геоданных не начинает отслеживать поездку. Чтобы задать идентификатор и начать отслеживание, используйте FleetEngineTripLocationProvider.tripId.
vehicleMarkerCustomization
необязательно
Тип: (function(TripMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Настройки, примененные к маркеру транспортного средства.

Используйте это поле, чтобы задать собственный стиль (например, значок маркера) и интерактивность (например, обработку кликов).
  • Если указан объект MarkerOptions, то после создания маркера к нему применяются изменения, указанные в этом объекте, и перезаписываются параметры по умолчанию, если они есть.
  • Если указана функция, она вызывается один раз при создании маркера, прежде чем он будет добавлен в представление карты. При этом вызове параметр isNew в объекте параметров функции имеет значение true. Кроме того, эта функция вызывается, когда поставщик данных о местоположении получает данные от Fleet Engine, независимо от того, изменились ли данные, соответствующие этому маркеру.

    Список предоставленных параметров и их использование см. в TripMarkerCustomizationFunctionParams.
waypointMarkerCustomization
необязательно
Настройка, примененная к маркеру путевой точки.

Используйте это поле, чтобы задать собственный стиль (например, значок маркера) и интерактивность (например, обработку кликов).
  • Если указан объект MarkerOptions, то после создания маркера к нему применяются изменения, указанные в этом объекте, и перезаписываются параметры по умолчанию, если они есть.
  • Если указана функция, она вызывается один раз при создании маркера, прежде чем он будет добавлен в представление карты. При этом вызове параметр isNew в объекте параметров функции имеет значение true. Кроме того, эта функция вызывается, когда поставщик данных о местоположении получает данные от Fleet Engine, независимо от того, изменились ли данные, соответствующие этому маркеру.

    Список предоставленных параметров и их использование см. в TripWaypointMarkerCustomizationFunctionParams.

Интерфейс FleetEngineTripLocationProviderUpdateEvent

интерфейс google.maps.journeySharing.FleetEngineTripLocationProviderUpdateEvent

Объект события, передаваемый обработчику событий при активации события FleetEngineTripLocationProvider.update.

trip
необязательно
Тип: Trip optional
Структура поездки, возвращенная обновлением. Неизменяемый.