Trip and Order Progress

FleetEngineTripLocationProvider 类

class google.maps.journeySharing.FleetEngineTripLocationProvider extends PollingLocationProvider, LocationProvider
library "journeySharing"

行程位置信息提供程序。

const {FleetEngineTripLocationProvider} = await google.maps.importLibrary("journeySharing");
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。设置此字段即可开始跟踪。
继承的方法: isPolling、pollingIntervalMillis
refresh
refresh()
参数:无
返回值:void
明确刷新跟踪的位置。
继承: addListener
error
function(event)
参数:
当位置信息提供程序遇到错误时触发的事件。
update
function(event)
在 Fleet Engine 数据更新请求完成时触发的事件。
继承: ispollingchange

FleetEngineTripLocationProviderOptions 接口

接口 google.maps.journeySharing.FleetEngineTripLocationProviderOptions

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    如需查看提供的参数及其用途的列表,请参阅 TripMarkerCustomizationFunctionParams。
waypointMarkerCustomization
可选
应用于航点标记的自定义设置。

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

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

FleetEngineTripLocationProviderUpdateEvent 接口

接口 google.maps.journeySharing.FleetEngineTripLocationProviderUpdateEvent

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

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