Shipment Tracking

Класс FleetEngineShipmentLocationProvider

google.maps.journeySharing . FleetEngineShipmentLocationProvider

Поставщик информации о месте отправки.

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

Доступ осуществляется путем вызова const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing") .
См. Библиотеки в Maps JavaScript API .

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 Web Tokens для аутентификации клиента в Fleet Engine.
projectId
Тип: string
Идентификатор проекта потребителя из Google Cloud Console.
activePolylineCustomization optional
Тип: (function( ShipmentPolylineCustomizationFunctionParams ): void)| PolylineOptions optional
Настройка, примененная к активной ломаной линии. Активная ломаная линия соответствует участку маршрута, по которому в данный момент движется транспортное средство.

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

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

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

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

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

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

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

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

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

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

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

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

Интерфейс FleetEngineShipmentLocationProviderUpdateEvent

google.maps.journeySharing . FleetEngineShipmentLocationProviderUpdateEvent

Объект события передается обработчику событий при возникновении события FleetEngineShipmentLocationProvider.update .

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