Shipment Tracking

Класс FleetEngineShipmentLocationProvider

google.maps.journeySharing.FleetEngineShipmentLocationProvider class
extends PollingLocationProvider
library "journeySharing"

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

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

Интерфейс FleetEngineShipmentLocationProviderOptions

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

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

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

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

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

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

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

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

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

По умолчанию интервал опроса составляет 5000 миллисекунд. Это минимальное значение. Если вы установите меньшее положительное значение, будет сохранено и использовано значение 5000.
remainingPolylineCustomization
необязательно
Настройки применены к оставшейся части ломаной линии. Оставшаяся ломаная линия соответствует части маршрута, которую транспортное средство ещё не начало проходить.

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

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

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

    Список предоставленных параметров и их использование приведены в ShipmentPolylineCustomizationFunctionParams.
trackingId
необязательно
Тип: string optional
Идентификатор отслеживания задачи, которую нужно отслеживать сразу после создания экземпляра поставщика данных о местоположении. Если он не указан, поставщик геоданных не начинает отслеживать задачи. Чтобы задать идентификатор отслеживания и начать отслеживание, используйте FleetEngineShipmentLocationProvider.trackingId.

Интерфейс FleetEngineShipmentLocationProviderUpdateEvent

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

Объект события, передаваемый обработчику событий при активации события FleetEngineShipmentLocationProvider.update.
taskTrackingInfo
необязательно
Тип: TaskTrackingInfo optional
Структура информации об отслеживании задач, возвращаемая обновлением. Неизменяемый.