Trip and Order Progress

FleetEngineTripLocationProvider

google.maps.journeySharing.FleetEngineTripLocationProvider

行程位置信息提供程序。

此类扩展了 PollingLocationProvider

通过调用 const {FleetEngineTripLocationProvider} = await google.maps.importLibrary("journeySharing") 进行访问。
请参阅 Maps JavaScript API 中的库

FleetEngineTripLocationProvider
FleetEngineTripLocationProvider(options)
参数: 
为 Fleet Engine 行程创建新的位置信息提供程序。
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION(params)
参数: 
返回值:无
一种多段线自定义函数,可根据活动多段线的速度读数为其着色。将此函数指定为 FleetEngineTripLocationProviderOptions.activePolylineCustomization,以针对活动多段线渲染一条考虑了路况的多段线。
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION(params)
参数: 
返回值:无
一种多段线自定义函数,可根据剩余多段线的速度读数为其着色。将此函数指定为 FleetEngineTripLocationProviderOptions.remainingPolylineCustomization,以渲染剩余多段线的流量感知型多段线。
tripId
类型:  string
相应位置信息提供程序所观测的行程的 ID。设置此字段以开始跟踪。
继承自isPollingpollingIntervalMillis
refresh
refresh()
参数:无
返回值:  void
显式刷新跟踪的位置。
继承自addListener
error
function(event)
实参: 
位置信息提供程序遇到错误时触发的事件。
update
function(event)
在 Fleet Engine 数据更新请求完成时触发的事件。
继承自ispollingchange

FleetEngineTripLocationProviderOptions 接口

google.maps.journeySharing.FleetEngineTripLocationProviderOptions 接口

行程位置信息提供方的选项。

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

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

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

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

    如需查看提供的参数及其用途的列表,请参阅 TripMarkerCustomizationFunctionParams
originMarkerCustomization optional
类型:  (function(TripMarkerCustomizationFunctionParams): void)|MarkerOptions optional
应用于出发地标记的自定义设置。

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

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

将此值设置为 0 可停用周期性位置更新。如果位置信息提供程序所观测到的任何参数发生变化,系统会提取新的位置信息更新。

默认轮询间隔为 5000 毫秒,即最短间隔。如果您将轮询间隔设置为较低的非零值,系统会使用 5000。
remainingPolylineCustomization optional
类型:  (function(TripPolylineCustomizationFunctionParams): void)|PolylineOptions optional
应用于其余多段线的自定义设置。剩余的折线对应于车辆尚未开始行驶的路线部分。

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

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

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

    如需查看提供的参数及其用途的列表,请参阅 TripPolylineCustomizationFunctionParams
tripId optional
类型:  string optional
在位置信息提供程序实例化后立即跟踪的行程 ID。如果未指定,位置信息提供程序不会开始跟踪任何行程;请使用 FleetEngineTripLocationProvider.tripId 设置 ID 并开始跟踪。
vehicleMarkerCustomization optional
类型:  (function(TripMarkerCustomizationFunctionParams): void)|MarkerOptions optional
应用于车辆标记的自定义设置。

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

    如需查看提供的参数及其用途的列表,请参阅 TripMarkerCustomizationFunctionParams
waypointMarkerCustomization optional
类型:  (function(TripWaypointMarkerCustomizationFunctionParams): void)|MarkerOptions optional
应用于途经点标记的自定义设置。

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

    如需查看提供的参数及其用途的列表,请参阅 TripWaypointMarkerCustomizationFunctionParams

FleetEngineTripLocationProviderUpdateEvent 接口

google.maps.journeySharing.FleetEngineTripLocationProviderUpdateEvent 接口

FleetEngineTripLocationProvider.update 事件触发时传递给事件处理程序的事件对象。

trip optional
类型:  Trip optional
更新返回的行程结构。不可修改。