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 Console 的使用方的项目 ID。 |
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，系统会停用周期性位置信息更新。如果位置信息提供程序观察到的任何参数发生更改，系统会提取新的位置信息更新。 默认的轮询时间间隔为 5000 毫秒（最小间隔）。如果您将轮询间隔设置为较低的非零值，则系统会使用 5000。 |
shouldShowOutcomeLocations optional |
类型：
boolean optional用于显示或隐藏已提取任务的结果位置的布尔值。 |
shouldShowTasks optional |
类型：
boolean optional用于显示或隐藏任务的布尔值。将此值设置为 false 将阻止调用 ListTasks 端点来获取任务。仅显示即将到来的车辆停靠点。 |
staleLocationThresholdMillis optional |
类型：
number optional车辆位置过时的阈值。如果车辆上次更新的位置在此阈值之前，则不会显示车辆。默认值为 24 小时（以毫秒为单位）。如果阈值小于 0 或 Infinity，则系统会忽略阈值，并且不会将车辆位置视为过时。 |
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 Console 的使用方的项目 ID。 |
deliveryVehicleFilter optional |
类型：
string optional提取车辆时应用的过滤条件查询。此过滤器直接传递给 Fleet Engine。 如需了解支持的格式，请参阅 ListDeliveryVehiclesRequest.filter。 请注意，属性的有效过滤条件必须带有“属性”前缀。例如， 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查询返回的送货工具列表。无法修改。 |