FleetEngineDeliveryVehicleLocationProvider 类
google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProvider
类
送货车辆位置信息提供程序。
此类扩展了 PollingLocationProvider
。
通过调用 const {FleetEngineDeliveryVehicleLocationProvider} = await google.maps.importLibrary("journeySharing")
进行访问。请参阅 Maps JavaScript API 中的库。
构造函数 | |
---|---|
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 |
类型:
string Google Cloud 控制台中的使用方项目 ID。 |
activePolylineCustomization optional |
类型:
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional 自定义设置会应用到当前使用的多段线。活跃多段线对应于车辆当前穿过的路线的一部分。 使用此字段可以指定自定义样式(例如多段线颜色)和互动性(例如点击处理)。
|
deliveryVehicleId optional |
类型:
string optional 在实例化位置信息提供程序后立即跟踪的送货车辆 ID。如果未指定,位置信息提供程序不会开始跟踪任何车辆;请使用 FleetEngineDeliveryVehicleLocationProvider.deliveryVehicleId 设置 ID 并开始跟踪。 |
deliveryVehicleMarkerCustomization optional |
类型:
(function(DeliveryVehicleMarkerCustomizationFunctionParams): void)|MarkerOptions optional 对送货车辆标记应用的自定义。 您可以使用此字段指定自定义样式(例如标记图标)和互动性(例如点击处理)。
|
plannedStopMarkerCustomization optional |
类型:
(function(PlannedStopMarkerCustomizationFunctionParams): void)|MarkerOptions optional 自定义内容已应用到计划的经停点标记。 您可以使用此字段指定自定义样式(例如标记图标)和互动性(例如点击处理)。
|
pollingIntervalMillis optional |
类型:
number optional 提取位置信息更新的最短时间(以毫秒为单位)。如果获取位置更新所需的时间超过 pollingIntervalMillis ,则只有当前位置更新完成后,系统才会开始下一次位置更新。将此值设置为 0 会停用定期位置信息更新。如果位置信息提供程序观察到的任何参数发生变化,系统会提取新的位置信息更新。 默认轮询间隔为 5, 000 毫秒,最小间隔。如果将轮询间隔设置为较小的非零值,则使用 5000。 |
remainingPolylineCustomization optional |
类型:
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional 自定义内容已应用于其余多段线。剩下的多段线对应于车辆尚未开始穿过的路线的一部分。 使用此字段可以指定自定义样式(例如多段线颜色)和互动性(例如点击处理)。
|
shouldShowOutcomeLocations optional |
类型:
boolean optional 用于显示或隐藏已提取任务的结果位置的布尔值。 |
shouldShowTasks optional |
类型:
boolean optional 用于显示或隐藏任务的布尔值。将此属性设置为 false 可阻止调用 ListTasks 端点来获取任务。将仅显示即将到来的车辆停靠站。 |
staleLocationThresholdMillis optional |
类型:
number optional 过时车辆位置信息的阈值。如果车辆上次更新的位置信息早于此阈值,则不会显示车辆。默认值为 24 小时(以毫秒为单位)。如果阈值小于 0 或无穷大,则系统会忽略阈值,并且车辆位置信息不会被视为已过时。 |
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 |
提供 JSON Web 令牌,用于向 Fleet Engine 验证客户端的身份。 |
projectId |
类型:
string Google Cloud 控制台中的使用方项目 ID。 |
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 小时(以毫秒为单位)。如果阈值小于零或无穷大,则系统会忽略阈值,并且车辆位置信息不会被视为已过时。 |
FleetEngineDeliveryFleetLocationProviderUpdateEvent 接口
google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderUpdateEvent
接口
触发 FleetEngineDeliveryFleetLocationProvider.update
事件时传递给事件处理脚本的事件对象。
属性 | |
---|---|
deliveryVehicles optional |
类型:
Array<DeliveryVehicle> optional 查询返回的送货车辆列表。不可修改。 |