FleetEngineDeliveryVehicleLocationProvider 类
google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProvider
类
配送车辆位置信息提供程序。
此类扩展了 PollingLocationProvider
。
通过调用 const {FleetEngineDeliveryVehicleLocationProvider} = await google.maps.importLibrary("journeySharing")
进行访问。请参阅 Maps JavaScript API 中的库。
构造函数 | |
---|---|
FleetEngineDeliveryVehicleLocationProvider |
FleetEngineDeliveryVehicleLocationProvider(options) 参数:
为车队引擎配送车辆创建新的位置信息提供程序。 |
属性 | |
---|---|
deliveryVehicleId |
类型:
string 此位置信息提供程序所监控的车辆的 ID。设置此字段以跟踪车辆。 |
shouldShowOutcomeLocations |
类型:
boolean optional 可选择允许用户显示任务的结果位置。 |
shouldShowTasks |
类型:
boolean optional (可选)允许用户显示提取的任务。 |
staleLocationThresholdMillis |
类型:
number 此字段为只读字段。车辆位置信息过时阈值。如果车辆的最后更新位置超过此阈值,系统将不会显示该车辆。 |
taskFilterOptions |
返回提取任务时要应用的过滤条件选项。 |
继承:
isPolling 、pollingIntervalMillis
|
方法 | |
---|---|
继承:
addListener
|
事件 | |
---|---|
error |
function(event) 参数:
当位置信息提供程序遇到错误时触发的事件。 |
update |
function(event) 在车队引擎数据更新请求完成时触发的事件。 |
继承:
ispollingchange
|
FleetEngineDeliveryVehicleLocationProviderOptions 接口
google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderOptions
接口
配送车辆位置信息提供程序的选项。
属性 | |
---|---|
authTokenFetcher |
类型:
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 会停用周期性位置信息更新。如果位置信息提供程序观察到的任何参数发生变化,系统就会提取新的定位信息更新。 默认的轮询间隔为 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) 参数:
为由车队引擎跟踪的车辆创建新的位置信息提供程序。 |
属性 | |
---|---|
deliveryVehicleFilter |
类型:
string optional 提取配送车辆时应用的过滤条件。 |
locationRestriction |
类型:
LatLngBounds|LatLngBoundsLiteral optional 用于跟踪配送车辆的边界。如果未设置边界,系统将不会跟踪任何配送车辆。如需跟踪所有配送车辆(无论其位置如何),请设置相当于整个地球的边界。 |
staleLocationThresholdMillis |
类型:
number 此字段为只读字段。车辆位置信息过时阈值。如果车辆的最后更新位置超过此阈值,系统将不会显示该车辆。 |
继承:
isPolling 、pollingIntervalMillis
|
方法 | |
---|---|
继承:
addListener
|
事件 | |
---|---|
update |
function(event) 在车队引擎数据更新请求完成时触发的事件。 |
继承:
ispollingchange
|
FleetEngineDeliveryFleetLocationProviderOptions 接口
google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderOptions
接口
配送车队位置信息提供程序的选项。
属性 | |
---|---|
authTokenFetcher |
类型:
AuthTokenFetcher 提供 JSON Web 令牌,用于对 Fleet Engine 进行客户端身份验证。 |
projectId |
类型:
string Google Cloud 控制台中的使用方的项目 ID。 |
deliveryVehicleFilter optional |
类型:
string optional 提取配送车辆时要应用的过滤查询。此过滤器会直接传递给车队引擎。 如需了解支持的格式,请参阅 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 查询返回的配送车辆列表。不可修改。 |