Класс FleetEngineDeliveryVehicleLocationProvider
google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProvider
класс
Поставщик данных о местоположении транспортного средства доставки.
Этот класс расширяет PollingLocationProvider.
Чтобы получить доступ, позвоните по номеру const {FleetEngineDeliveryVehicleLocationProvider} = await google.maps.importLibrary("journeySharing").
Подробнее о библиотеках Maps JavaScript API…
Конструктор | |
|---|---|
FleetEngineDeliveryVehicleLocationProvider |
FleetEngineDeliveryVehicleLocationProvider(options)Параметры:
Создает нового поставщика местоположения для транспортного средства доставки Fleet Engine. |
Свойства | |
|---|---|
deliveryVehicleId |
Тип:
stringИдентификатор транспортного средства, за которым наблюдает этот поставщик данных о местоположении. Задайте это поле, чтобы отслеживать транспортное средство. |
shouldShowOutcomeLocations |
Тип:
boolean optionalПри необходимости разрешите пользователям показывать местоположение, связанное с результатом задачи. |
shouldShowTasks |
Тип:
boolean optionalПри необходимости разрешите пользователям показывать полученные задачи. |
staleLocationThresholdMillis |
Тип:
numberЭто поле доступно только для чтения. Пороговое значение для устаревшего местоположения транспортного средства. Если последнее обновленное местоположение транспортного средства старше этого порогового значения, транспортное средство не будет отображаться. |
taskFilterOptions |
Возвращает параметры фильтра, которые будут применены при получении задач. |
Унаследованные:
isPolling,
pollingIntervalMillis
| |
Методы | |
|---|---|
Унаследованные:
addListener
|
События | |
|---|---|
error |
function(event)Аргументы:
Событие, которое активируется, когда поставщик данных о местоположении сталкивается с ошибкой. |
update |
function(event)Аргументы:
Событие, которое активируется, когда запрос на обновление данных Fleet Engine завершен. |
Унаследованные:
ispollingchange
| |
Интерфейс FleetEngineDeliveryVehicleLocationProviderOptions
google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderOptions
интерфейс
Параметры поставщика данных о местоположении транспортного средства доставки.
Свойства | |
|---|---|
authTokenFetcher |
Тип:
AuthTokenFetcherПредоставляет веб-токены JSON для аутентификации клиента в Fleet Engine. |
projectId |
Тип:
stringИдентификатор проекта клиента из консоли Google Cloud. |
activePolylineCustomization optional |
Тип:
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optionalНастройки, примененные к активной ломаной линии. Активная ломаная линия соответствует части маршрута, по которой в данный момент движется транспортное средство. Используйте это поле, чтобы задать собственный стиль (например, цвет ломаной линии) и интерактивность (например, обработку кликов).
|
deliveryVehicleId optional |
Тип:
string optionalИдентификатор транспортного средства доставки, которое нужно отслеживать сразу после создания экземпляра поставщика местоположения. Если идентификатор не указан, поставщик геолокации не начнет отслеживать транспортное средство. Чтобы задать идентификатор и начать отслеживание, используйте FleetEngineDeliveryVehicleLocationProvider.deliveryVehicleId. |
deliveryVehicleMarkerCustomization optional |
Тип:
(function(DeliveryVehicleMarkerCustomizationFunctionParams): void)|MarkerOptions optionalНастройка, примененная к маркеру транспортного средства доставки. Используйте это поле, чтобы задать собственный стиль (например, значок маркера) и интерактивность (например, обработку кликов).
|
plannedStopMarkerCustomization optional |
Тип:
(function(PlannedStopMarkerCustomizationFunctionParams): void)|MarkerOptions optionalНастройка, примененная к маркеру запланированной остановки. Используйте это поле, чтобы задать собственный стиль (например, значок маркера) и интерактивность (например, обработку кликов).
|
pollingIntervalMillis optional |
Тип:
number optionalМинимальное время между получением обновлений местоположения в миллисекундах. Если на получение данных о местоположении уходит больше pollingIntervalMillis, следующее обновление не начнется, пока не завершится текущее. Если задать значение 0, регулярные обновления местоположения будут отключены. Новое уведомление о местоположении запрашивается, если меняется любой из параметров, отслеживаемых поставщиком геолокации. По умолчанию интервал опроса составляет 5000 миллисекунд (минимальное значение). Если вы установите меньшее ненулевое значение, будет использоваться 5000. |
remainingPolylineCustomization optional |
Тип:
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optionalНастройки применены к оставшейся части ломаной линии. Оставшаяся ломаная линия соответствует части маршрута, которую транспортное средство ещё не начало проходить. Используйте это поле, чтобы задать собственный стиль (например, цвет ломаной линии) и интерактивность (например, обработку кликов).
|
shouldShowOutcomeLocations optional |
Тип:
boolean optionalЛогическое значение, определяющее, нужно ли показывать местоположения результатов для полученных задач. |
shouldShowTasks optional |
Тип:
boolean optionalЛогическое значение, определяющее, нужно ли показывать задачи. Если задать значение false, конечная точка ListTasks не будет вызываться для получения задач. Будут показаны только предстоящие остановки. |
staleLocationThresholdMillis optional |
Тип:
number optionalПороговое значение для устаревшего местоположения транспортного средства. Если последнее обновленное местоположение транспортного средства старше этого порогового значения, транспортное средство не будет отображаться. По умолчанию – 24 часа в миллисекундах. Если пороговое значение меньше 0 или равно Infinity, оно будет игнорироваться, а местоположение транспортного средства не будет считаться устаревшим. |
takenPolylineCustomization optional |
Тип:
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optionalНастройки, примененные к выбранной ломаной линии. Пройденная ломаная линия соответствует части маршрута, которую транспортное средство уже преодолело. Используйте это поле, чтобы задать собственный стиль (например, цвет ломаной линии) и интерактивность (например, обработку кликов).
|
taskFilterOptions optional |
Тип:
FleetEngineTaskFilterOptions optionalПараметры фильтра, которые будут применяться при получении задач. Например, можно указать транспортное средство, время и статус задачи. |
taskMarkerCustomization optional |
Тип:
(function(TaskMarkerCustomizationFunctionParams): void)|MarkerOptions optionalНастройка, примененная к маркеру задачи. Маркер задачи отображается в запланированном местоположении каждой задачи, назначенной транспортному средству доставки. Используйте это поле, чтобы задать собственный стиль (например, значок маркера) и интерактивность (например, обработку кликов).
|
taskOutcomeMarkerCustomization optional |
Тип:
function(TaskMarkerCustomizationFunctionParams): void optionalНастройка, примененная к маркеру результата задачи. Маркер результата задачи отображается в фактическом местоположении результата каждой задачи, назначенной транспортному средству доставки. Используйте это поле, чтобы задать собственный стиль (например, значок маркера) и интерактивность (например, обработку кликов).
|
Интерфейс FleetEngineTaskFilterOptions
google.maps.journeySharing.FleetEngineTaskFilterOptions
интерфейс
Параметры фильтрации задач в поставщике местоположения транспортного средства доставки.
Свойства | |
|---|---|
completionTimeFrom optional |
Тип:
Date optionalНижняя граница времени выполнения задачи (не включается). Используется для фильтрации задач, выполненных после указанного времени. |
completionTimeTo optional |
Тип:
Date optionalВерхняя граница времени выполнения задачи (не включается). Используется для фильтрации задач, которые были выполнены до указанного времени. |
state optional |
Тип:
string optionalСтатус задачи. Допустимые значения: OPEN (открыто) или CLOSED (закрыто). |
Интерфейс FleetEngineDeliveryVehicleLocationProviderUpdateEvent
google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderUpdateEvent
интерфейс
Объект события, передаваемый обработчику событий при активации события FleetEngineDeliveryVehicleLocationProvider.update.
Свойства | |
|---|---|
completedVehicleJourneySegments optional |
Тип:
Array<VehicleJourneySegment> optionalОтрезки маршрута, которые уже пройдены этим транспортным средством. Неизменяемый. |
deliveryVehicle optional |
Тип:
DeliveryVehicle optionalСтруктура данных транспортного средства доставки, возвращенная обновлением. Неизменяемый. |
tasks optional |
Список задач, выполняемых этим транспортным средством доставки. Неизменяемый. |
Класс FleetEngineDeliveryFleetLocationProvider
google.maps.journeySharing.FleetEngineDeliveryFleetLocationProvider
класс
Поставщик данных о местоположении автопарка доставки.
Этот класс расширяет PollingLocationProvider.
Чтобы получить доступ, позвоните по номеру const {FleetEngineDeliveryFleetLocationProvider} = await google.maps.importLibrary("journeySharing").
Подробнее о библиотеках Maps JavaScript API…
Конструктор | |
|---|---|
FleetEngineDeliveryFleetLocationProvider |
FleetEngineDeliveryFleetLocationProvider(options)Параметры:
Создает нового поставщика данных о местоположении для транспортных средств, отслеживаемых Fleet Engine. |
Свойства | |
|---|---|
deliveryVehicleFilter |
Тип:
string optionalФильтр, применяемый при получении транспортных средств доставки. |
locationRestriction |
Тип:
LatLngBounds|LatLngBoundsLiteral optionalГраницы, в пределах которых нужно отслеживать транспортные средства доставки. Если границы не заданы, транспортные средства отслеживаться не будут. Чтобы отслеживать все транспортные средства доставки независимо от местоположения, установите границы, эквивалентные всей Земле. |
staleLocationThresholdMillis |
Тип:
numberЭто поле доступно только для чтения. Пороговое значение для устаревшего местоположения транспортного средства. Если последнее обновленное местоположение транспортного средства старше этого порогового значения, транспортное средство не будет отображаться. |
Унаследованные:
isPolling,
pollingIntervalMillis
| |
Методы | |
|---|---|
Унаследованные:
addListener
|
События | |
|---|---|
update |
function(event)Аргументы:
Событие, которое активируется, когда запрос на обновление данных Fleet Engine завершен. |
Унаследованные:
ispollingchange
| |
Интерфейс FleetEngineDeliveryFleetLocationProviderOptions
google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderOptions
интерфейс
Варианты поставщика данных о местоположении автопарка доставки.
Свойства | |
|---|---|
authTokenFetcher |
Тип:
AuthTokenFetcherПредоставляет веб-токены JSON для аутентификации клиента в Fleet Engine. |
projectId |
Тип:
stringИдентификатор проекта клиента из консоли Google Cloud. |
deliveryVehicleFilter optional |
Тип:
string optionalЗапрос фильтра, который будет применяться при получении транспортных средств доставки. Этот фильтр передается непосредственно в Fleet Engine. Поддерживаемые форматы перечислены в разделе ListDeliveryVehiclesRequest.filter. Обратите внимание, что у допустимых фильтров для атрибутов должен быть префикс attributes. Примеры: attributes.x = "y" или attributes."x y" = "z". |
deliveryVehicleMarkerCustomization optional |
Тип:
function(DeliveryVehicleMarkerCustomizationFunctionParams): void optionalНастройка, примененная к маркеру транспортного средства доставки. Используйте это поле, чтобы задать собственный стиль (например, значок маркера) и интерактивность (например, обработку кликов).
|
locationRestriction optional |
Тип:
LatLngBounds|LatLngBoundsLiteral optionalГраницы широты и долготы, в пределах которых нужно отслеживать транспортные средства сразу после создания экземпляра поставщика геоданных. Если границы не заданы, поставщик данных о местоположении не начнет отслеживать транспортные средства. Чтобы задать границы и начать отслеживание, используйте FleetEngineDeliveryFleetLocationProvider.locationRestriction. Чтобы отслеживать все транспортные средства доставки независимо от местоположения, установите границы, эквивалентные всей Земле. |
staleLocationThresholdMillis optional |
Тип:
number optionalПороговое значение для устаревшего местоположения транспортного средства. Если последнее обновленное местоположение транспортного средства старше этого порогового значения, транспортное средство не будет отображаться. По умолчанию – 24 часа в миллисекундах. Если пороговое значение меньше нуля или равно Infinity, оно будет игнорироваться, а местоположение транспортного средства не будет считаться устаревшим. |
Интерфейс FleetEngineDeliveryFleetLocationProviderUpdateEvent
google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderUpdateEvent
интерфейс
Объект события, передаваемый обработчику событий при активации события FleetEngineDeliveryFleetLocationProvider.update.
Свойства | |
|---|---|
deliveryVehicles optional |
Тип:
Array<DeliveryVehicle> optionalСписок транспортных средств доставки, возвращенных запросом. Неизменяемый. |