Shipment Tracking

Класс FleetEngineShipmentLocationProvider

google.maps.journeySharing . 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 Интерфейс google.maps.journeySharing . FleetEngineShipmentLocationProviderOptions

Варианты поставщика места отгрузки.

authTokenFetcher
Предоставляет веб-токены JSON для аутентификации клиента в 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 Интерфейс google.maps.journeySharing . FleetEngineShipmentLocationProviderUpdateEvent

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

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