FleetEngineDeliveryVehicleLocationProvider 类
class
google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProvider
extends PollingLocationProvider, LocationProvider
library "journeySharing"
配送车辆位置信息提供程序。
const {FleetEngineDeliveryVehicleLocationProvider} = await google.maps.importLibrary("journeySharing");
构造函数 | |
|---|---|
FleetEngineDeliveryVehicleLocationProvider |
FleetEngineDeliveryVehicleLocationProvider(options)参数：
为 Fleet Engine 配送车辆创建新的位置信息提供程序。 |
属性 | |
|---|---|
deliveryVehicleId |
类型：
string此位置信息提供程序观察的车辆的 ID。设置此字段可跟踪车辆。 |
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 |
提供 JSON Web 令牌，用于向 Fleet Engine 验证客户端身份。 |
projectId |
类型：
stringGoogle Cloud 控制台中的使用方项目 ID。 |
activePolylineCustomization
可选 |
类型：
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional自定义设置已应用于活动多段线。有效多段线对应于车辆当前正在行驶的路线部分。 使用此字段可指定自定义样式（例如多段线颜色）和可交互性（例如点击处理）。
|
deliveryVehicleId
可选 |
类型：
string optional在位置信息提供程序实例化后立即跟踪的配送车辆 ID。如果未指定，位置信息提供程序不会开始跟踪任何车辆；请使用 FleetEngineDeliveryVehicleLocationProvider.deliveryVehicleId 设置 ID 并开始跟踪。 |
deliveryVehicleMarkerCustomization
可选 |
类型：
(function(DeliveryVehicleMarkerCustomizationFunctionParams): void)|应用于送货车辆标记的自定义设置。 使用此字段可指定自定义样式（例如标记图标）和互动性（例如点击处理）。
|
plannedStopMarkerCustomization
可选 |
类型：
(function(PlannedStopMarkerCustomizationFunctionParams): void)|应用于计划停靠点标记的自定义设置。 使用此字段可指定自定义样式（例如标记图标）和互动性（例如点击处理）。
|
pollingIntervalMillis
可选 |
类型：
number optional两次获取位置信息更新之间的最短时间间隔（以毫秒为单位）。如果获取位置信息更新的时间超过 pollingIntervalMillis，则在当前位置信息更新完成之前，系统不会启动下一次位置信息更新。将此值设为 0 会停用定期位置信息更新。如果位置信息提供程序观察到的任何参数发生变化，系统就会提取新的位置信息更新。 默认轮询间隔为 5000 毫秒，这是最短间隔。如果您将轮询间隔设置为较低的非零值，则系统会使用 5000。 |
remainingPolylineCustomization
可选 |
类型：
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional应用于多段线其余部分的自定义设置。剩余多段线对应于车辆尚未开始行驶的路线部分。 使用此字段可指定自定义样式（例如多段线颜色）和可交互性（例如点击处理）。
|
shouldShowOutcomeLocations
可选 |
类型：
boolean optional布尔值，用于显示或隐藏所提取任务的结果位置。 |
shouldShowTasks
可选 |
类型：
boolean optional用于显示或隐藏任务的布尔值。如果将此值设置为 false，则系统不会调用 ListTasks 端点来提取任务。系统只会显示即将到达的车辆停靠站。 |
staleLocationThresholdMillis
可选 |
类型：
number optional车辆位置信息过时的阈值。如果车辆的最后更新位置早于此阈值，则不会显示该车辆。默认值为 24 小时（以毫秒为单位）。如果阈值小于 0 或为 Infinity，系统会忽略该阈值，并且不会将车辆位置视为过时。 |
takenPolylineCustomization
可选 |
类型：
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional应用于所选多段线的自定义设置。已行驶多段线对应于车辆已行驶过的路线部分。 使用此字段可指定自定义样式（例如多段线颜色）和可交互性（例如点击处理）。
|
taskFilterOptions
可选 |
类型：
FleetEngineTaskFilterOptions optional提取任务时要应用的过滤条件选项。选项可以包括特定车辆、时间和任务状态。 |
taskMarkerCustomization
可选 |
类型：
(function(TaskMarkerCustomizationFunctionParams): void)|应用于任务标记的自定义设置。系统会在分配给配送车辆的每项任务的计划位置呈现任务标记。 使用此字段可指定自定义样式（例如标记图标）和互动性（例如点击处理）。
|
taskOutcomeMarkerCustomization
可选 |
类型：
function(TaskMarkerCustomizationFunctionParams): void optional应用于任务结果标记的自定义。任务结果标记会在分配给配送车辆的每项任务的实际结果位置处呈现。 使用此字段可指定自定义样式（例如标记图标）和互动性（例如点击处理）。
|
FleetEngineTaskFilterOptions 接口
接口
google.maps.journeySharing.FleetEngineTaskFilterOptions
配送车辆位置信息提供程序中任务的过滤选项。
属性 | |
|---|---|
completionTimeFrom
可选 |
类型：
Date optional任务完成时间的下限（不含）。用于过滤在指定时间之后完成的任务。 |
completionTimeTo
可选 |
类型：
Date optional任务完成时间的上限（不含）。用于过滤在指定时间之前完成的任务。 |
state
可选 |
类型：
string optional任务的状态。有效值为 OPEN 或 CLOSED。 |
FleetEngineDeliveryVehicleLocationProviderUpdateEvent 接口
接口
google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderUpdateEvent
触发 FleetEngineDeliveryVehicleLocationProvider.update 事件时传递给事件处理脚本的事件对象。
属性 | |
|---|---|
completedVehicleJourneySegments
可选 |
类型：
Array<VehicleJourneySegment> optional此车辆已完成的行程路段。不可修改。 |
deliveryVehicle
可选 |
类型：
DeliveryVehicle optional更新返回的配送车辆数据结构。不可修改。 |
tasks
可选 |
此配送车辆服务的任务列表。不可修改。 |
FleetEngineDeliveryFleetLocationProvider 类
class
google.maps.journeySharing.FleetEngineDeliveryFleetLocationProvider
extends PollingLocationProvider, LocationProvider
library "journeySharing"
配送车队位置信息提供程序。
const {FleetEngineDeliveryFleetLocationProvider} = await google.maps.importLibrary("journeySharing");
构造函数 | |
|---|---|
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 |
提供 JSON Web 令牌，用于向 Fleet Engine 验证客户端身份。 |
projectId |
类型：
stringGoogle Cloud 控制台中的使用方项目 ID。 |
deliveryVehicleFilter
可选 |
类型：
string optional提取配送车辆时要应用的过滤条件查询。此过滤条件会直接传递给 Fleet Engine。 如需了解支持的格式，请参阅 ListDeliveryVehiclesRequest.filter。 请注意，属性的有效过滤条件必须具有“attributes”前缀。例如， attributes.x = "y" 或 attributes."x y" = "z"。 |
deliveryVehicleMarkerCustomization
可选 |
类型：
function(DeliveryVehicleMarkerCustomizationFunctionParams): void optional应用于送货车辆标记的自定义设置。 使用此字段可指定自定义样式（例如标记图标）和互动性（例如点击处理）。
|
locationRestriction
可选 |
类型：
LatLngBounds|LatLngBoundsLiteral optional在位置信息提供程序实例化后，立即在其中跟踪车辆的纬度/经度边界。如果未设置，位置信息提供程序不会开始跟踪任何车辆；请使用 FleetEngineDeliveryFleetLocationProvider.locationRestriction 设置边界并开始跟踪。如需跟踪所有配送车辆（无论其位置如何），请设置相当于整个地球的边界。 |
staleLocationThresholdMillis
可选 |
类型：
number optional车辆位置信息过时的阈值。如果车辆的最后更新位置早于此阈值，则不会显示该车辆。默认值为 24 小时（以毫秒为单位）。如果阈值小于零或为 Infinity，系统会忽略该阈值，并且不会将车辆位置视为过时。 |
FleetEngineDeliveryFleetLocationProviderUpdateEvent 接口
接口
google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderUpdateEvent
触发 FleetEngineDeliveryFleetLocationProvider.update 事件时传递给事件处理脚本的事件对象。
属性 | |
|---|---|
deliveryVehicles
可选 |
类型：
Array<DeliveryVehicle> optional查询返回的配送车辆列表。不可修改。 |