Shipment Tracking

FleetEngineShipmentLocationProvider 类

google.maps.journeySharing.FleetEngineShipmentLocationProvider 类

配送位置信息提供程序。

此类扩展了 PollingLocationProvider。

通过调用 const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing") 进行访问。请参阅 Maps JavaScript API 中的库。
FleetEngineShipmentLocationProvider
FleetEngineShipmentLocationProvider(options)
参数： 
为车队引擎运输跟踪创建新的位置信息提供程序。
trackingId
类型：  string
此位置信息提供程序所监控任务的跟踪 ID。设置此字段即可开始跟踪。
继承： isPolling、pollingIntervalMillis
refresh
refresh()
参数：无
返回值：  void
明确刷新跟踪的位置信息。
继承： addListener
error
function(event)
参数： 
当位置信息提供程序遇到错误时触发的事件。
update
function(event)
参数： 
在车队引擎数据更新请求完成时触发的事件。
继承： ispollingchange

FleetEngineShipmentLocationProviderOptions 接口

google.maps.journeySharing.FleetEngineShipmentLocationProviderOptions 接口

ShipmentLocationProvider 的选项。
authTokenFetcher
类型：  AuthTokenFetcher
提供 JSON Web 令牌，用于对 Fleet Engine 进行客户端身份验证。
projectId
类型：  string
Google Cloud 控制台中的使用方的项目 ID。
activePolylineCustomization optional
类型：  (function(ShipmentPolylineCustomizationFunctionParams): void)|PolylineOptions optional
应用于有效多段线的自定义设置。有效的多段线对应于车辆当前正在穿越的路线的一部分。

使用此字段指定自定义样式（例如多段线颜色）和交互性（例如点击处理）。
  • 如果指定了 PolylineOptions 对象，则在创建多段线后，系统会将其中指定的更改应用于多段线，并覆盖其默认选项（如果有）。
  • 如果指定了函数，系统会在创建多段线时调用该函数一次。（在此调用中，函数参数对象中的 isNew 参数会设为 true。）此外，当多段线的坐标发生变化或位置信息提供程序从车队引擎收到数据时，系统也会调用此函数，无论与此多段线对应的数据是否发生了变化。

    如需查看所提供参数及其用法列表，请参阅 ShipmentPolylineCustomizationFunctionParams。
deliveryVehicleMarkerCustomization optional
类型：  (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional
应用于配送车辆标记的自定义设置。

使用此字段指定自定义样式（例如标记图标）和交互性（例如点击处理）。
  • 如果指定了 MarkerOptions 对象，则在创建标记后，系统会将其中指定的更改应用于该标记，并覆盖其默认选项（如果有）。
  • 如果指定了函数，系统会在创建标记后（在将其添加到地图视图之前）调用该函数一次。（在此调用中，函数参数对象中的 isNew 参数会设置为 true。）此外，当位置信息提供程序从车队引擎收到数据时，系统也会调用此函数，无论与此标记对应的数据是否已更改。

    如需查看所提供参数及其用法列表，请参阅 ShipmentMarkerCustomizationFunctionParams。
destinationMarkerCustomization optional
类型：  (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional
应用于目的地标记的自定义设置。

使用此字段指定自定义样式（例如标记图标）和交互性（例如点击处理）。
  • 如果指定了 MarkerOptions 对象，则在创建标记后，系统会将其中指定的更改应用于该标记，并覆盖其默认选项（如果有）。
  • 如果指定了函数，系统会在创建标记后（在将其添加到地图视图之前）调用该函数一次。（在此调用中，函数参数对象中的 isNew 参数会设置为 true。）此外，当位置信息提供程序从车队引擎收到数据时，系统也会调用此函数，无论与此标记对应的数据是否已更改。

    如需查看所提供参数及其用法列表，请参阅 ShipmentMarkerCustomizationFunctionParams。
pollingIntervalMillis optional
类型：  number optional
提取位置信息更新之间的最短时间（以毫秒为单位）。如果提取位置信息更新所需的时间超过 pollingIntervalMillis，则系统会等到当前位置信息更新完成后再开始下一个位置信息更新。

将此值设为 0、Infinity 或负值会停用自动位置信息更新。如果跟踪 ID 参数（例如运输位置信息提供程序的运输跟踪 ID）或过滤选项（例如车队位置信息提供程序的视口边界或属性过滤条件）发生变化，系统会提取一次新的位置信息更新。

默认的轮询间隔（也是最短间隔）为 5000 毫秒。如果您将轮询间隔设置为较低的正值，系统会存储并使用 5000。
remainingPolylineCustomization optional
类型：  (function(ShipmentPolylineCustomizationFunctionParams): void)|PolylineOptions optional
自定义应用于其余多段线。剩余的多段线对应于车辆尚未开始穿越的路线部分。

使用此字段指定自定义样式（例如多段线颜色）和交互性（例如点击处理）。
  • 如果指定了 PolylineOptions 对象，则在创建多段线后，系统会将其中指定的更改应用于多段线，并覆盖其默认选项（如果有）。
  • 如果指定了函数，系统会在创建多段线时调用该函数一次。（在此调用中，函数参数对象中的 isNew 参数会设为 true。）此外，当多段线的坐标发生变化或位置信息提供程序从车队引擎收到数据时，系统也会调用此函数，无论与此多段线对应的数据是否发生了变化。

    如需查看所提供参数及其用法列表，请参阅 ShipmentPolylineCustomizationFunctionParams。
takenPolylineCustomization optional
类型：  (function(ShipmentPolylineCustomizationFunctionParams): void)|PolylineOptions optional
应用于所绘制多段线的自定义设置。所采集的多段线对应于车辆已经过的路线的一部分。

使用此字段指定自定义样式（例如多段线颜色）和交互性（例如点击处理）。
  • 如果指定了 PolylineOptions 对象，则在创建多段线后，系统会将其中指定的更改应用于多段线，并覆盖其默认选项（如果有）。
  • 如果指定了函数，系统会在创建多段线时调用该函数一次。（在此调用中，函数参数对象中的 isNew 参数会设为 true。）此外，当多段线的坐标发生变化或位置信息提供程序从车队引擎收到数据时，系统也会调用此函数，无论与此多段线对应的数据是否发生了变化。

    如需查看所提供参数及其用法列表，请参阅 ShipmentPolylineCustomizationFunctionParams。
trackingId optional
类型：  string optional
在实例化位置信息提供程序后立即跟踪的任务的跟踪 ID。如果未指定，位置信息提供程序不会开始跟踪任何任务；请使用 FleetEngineShipmentLocationProvider.trackingId 设置跟踪 ID 并开始跟踪。

FleetEngineShipmentLocationProviderUpdateEvent 接口

google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent 接口

在触发 FleetEngineShipmentLocationProvider.update 事件时传递给事件处理脚本的事件对象。
taskTrackingInfo optional
类型：  TaskTrackingInfo optional
更新返回的任务跟踪信息结构。不可修改。