Shipment Tracking

FleetEngineShipmentLocationProvider 类

google.maps.journeySharing.FleetEngineShipmentLocationProvider 类

货件位置信息提供方。

此类扩展了 PollingLocationProvider。

通过调用 const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing") 进行访问。
请参阅 Maps JavaScript API 中的库。
FleetEngineShipmentLocationProvider
FleetEngineShipmentLocationProvider(options)
参数： 
为 Fleet Engine 货物追踪创建新的位置信息提供程序。
trackingId
类型：  string
相应位置信息提供程序所观察的任务的跟踪 ID。设置此字段以开始跟踪。
继承自： isPolling、 pollingIntervalMillis
refresh
refresh()
参数：无
返回值：  void
显式刷新跟踪的位置。
继承自： addListener
error
function(event)
实参： 
位置信息提供程序遇到错误时触发的事件。
update
function(event)
实参： 
在 Fleet Engine 数据更新请求完成时触发的事件。
继承自： ispollingchange

FleetEngineShipmentLocationProviderOptions 接口

google.maps.journeySharing.FleetEngineShipmentLocationProviderOptions 接口

货件位置信息提供方的选项。
authTokenFetcher
类型：  AuthTokenFetcher
提供用于向 Fleet Engine 验证客户端身份的 JSON Web 令牌。
projectId
类型：  string
Google Cloud 控制台中的消费者的项目 ID。
activePolylineCustomization optional
类型：  (function(ShipmentPolylineCustomizationFunctionParams): void)|PolylineOptions optional
已应用于活动多段线的自定义设置。有效多段线对应于车辆当前正在行驶的路线的一部分。

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

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

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

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

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

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

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

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

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

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

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

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

FleetEngineShipmentLocationProviderUpdateEvent 接口

google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent 接口

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