FleetEngineVehicleLocationProvider 类
google.maps.journeySharing.FleetEngineVehicleLocationProvider
类
车辆位置信息提供程序。
此类扩展了 PollingLocationProvider
。
通过调用 const {FleetEngineVehicleLocationProvider} = await google.maps.importLibrary("journeySharing")
进行访问。
请参阅 Maps JavaScript API 中的库。
构造函数 | |
---|---|
FleetEngineVehicleLocationProvider |
FleetEngineVehicleLocationProvider(options) 参数:
为 Fleet Engine 车辆创建新的位置信息提供程序。 |
静态方法 | |
---|---|
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION |
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION(params) 参数:
返回值:无
一种多段线自定义函数,可根据活动多段线的速度读数为其着色。将此函数指定为 FleetEngineVehicleLocationProviderOptions.activePolylineCustomization ,以针对活动多段线渲染一条考虑了路况的多段线。 |
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION |
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION(params) 参数:
返回值:无
一种多段线自定义函数,可根据剩余多段线的速度读数为其着色。将此函数指定为 FleetEngineVehicleLocationProviderOptions.remainingPolylineCustomization ,以渲染剩余多段线的流量感知型多段线。 |
属性 | |
---|---|
staleLocationThresholdMillis |
类型:
number 此字段为只读字段。过时车辆位置信息的阈值。如果车辆的上次更新位置信息的时间早于此阈值,则系统不会显示该车辆。 |
vehicleId |
类型:
string 相应位置信息提供程序所观测的车辆的 ID。将此字段设置为跟踪车辆。 |
继承自:
isPolling 、
pollingIntervalMillis
|
方法 | |
---|---|
继承自:
addListener
|
事件 | |
---|---|
error |
function(event) 实参:
位置信息提供程序遇到错误时触发的事件。 |
update |
function(event) 在 Fleet Engine 数据更新请求完成时触发的事件。 |
继承自:
ispollingchange
|
FleetEngineVehicleLocationProviderOptions 接口
google.maps.journeySharing.FleetEngineVehicleLocationProviderOptions
接口
车辆位置信息提供方的选项。
属性 | |
---|---|
authTokenFetcher |
类型:
AuthTokenFetcher 提供用于向 Fleet Engine 验证客户端身份的 JSON Web 令牌。 |
projectId |
类型:
string Google Cloud 控制台中的消费者的项目 ID。 |
activePolylineCustomization optional |
类型:
(function(VehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional 已应用于活动多段线的自定义设置。有效多段线对应于车辆当前正在行驶的路线的一部分。 使用此字段可指定自定义样式(例如折线颜色)和互动性(例如点击处理)。
|
destinationMarkerCustomization optional |
类型:
(function(VehicleWaypointMarkerCustomizationFunctionParams): void)|MarkerOptions optional 应用于车辆行程目的地标记的自定义设置。 使用此字段可指定自定义样式(例如标记图标)和互动性(例如点击处理)。
|
intermediateDestinationMarkerCustomization optional |
类型:
(function(VehicleWaypointMarkerCustomizationFunctionParams): void)|MarkerOptions optional 应用于车辆行程中途目的地标记的自定义设置。 使用此字段可指定自定义样式(例如标记图标)和互动性(例如点击处理)。
|
originMarkerCustomization optional |
类型:
(function(VehicleWaypointMarkerCustomizationFunctionParams): void)|MarkerOptions optional 应用于车辆行程出发地标记的自定义设置。 使用此字段可指定自定义样式(例如标记图标)和互动性(例如点击处理)。
|
pollingIntervalMillis optional |
类型:
number optional 提取位置更新之间的最短时间(以毫秒为单位)。如果获取位置信息更新所需的时间超过 pollingIntervalMillis ,则在当前位置信息更新完成之前,不会开始下一次位置信息更新。将此值设置为 0 可停用周期性位置更新。如果位置信息提供程序所观测到的任何参数发生变化,系统会提取新的位置信息更新。 默认轮询间隔为 5000 毫秒,即最短间隔。如果您将轮询间隔设置为较低的非零值,系统会使用 5000。 |
remainingPolylineCustomization optional |
类型:
(function(VehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional 应用于其余多段线的自定义设置。剩余的折线对应于车辆尚未开始行驶的路线部分。 使用此字段可指定自定义样式(例如折线颜色)和互动性(例如点击处理)。
|
staleLocationThresholdMillis optional |
类型:
number optional 过时车辆位置信息的阈值。如果车辆的上次更新位置信息的时间早于此阈值,则系统不会显示该车辆。默认值为 24 小时(以毫秒为单位)。如果阈值小于 0 或为 Infinity,则系统会忽略该阈值,并且不会将车辆位置视为过时。 |
takenPolylineCustomization optional |
类型:
(function(VehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional 已应用于拍摄的多段线的自定义设置。已走过的多段线对应于车辆已走过的部分路线。 使用此字段可指定自定义样式(例如折线颜色)和互动性(例如点击处理)。
|
vehicleId optional |
类型:
string optional 在位置信息提供程序实例化后立即跟踪的车辆 ID。如果未指定,位置信息提供程序不会开始跟踪任何车辆;请使用 FleetEngineVehicleLocationProvider.vehicleId 设置 ID 并开始跟踪。 |
vehicleMarkerCustomization optional |
类型:
(function(VehicleMarkerCustomizationFunctionParams): void)|MarkerOptions optional 应用于车辆标记的自定义设置。 使用此字段可指定自定义样式(例如标记图标)和互动性(例如点击处理)。
|
FleetEngineVehicleLocationProviderUpdateEvent 接口
google.maps.journeySharing.FleetEngineVehicleLocationProviderUpdateEvent
接口
当 FleetEngineVehicleLocationProvider.update
事件触发时传递给事件处理程序的事件对象。
属性 | |
---|---|
trips optional |
相应车辆已完成的行程列表。不可修改。 |
vehicle optional |
类型:
Vehicle optional 更新返回的车辆数据结构。不可修改。 |
FleetEngineFleetLocationProvider 类
google.maps.journeySharing.FleetEngineFleetLocationProvider
类
Fleet Location Provider。
此类扩展了 PollingLocationProvider
。
通过调用 const {FleetEngineFleetLocationProvider} = await google.maps.importLibrary("journeySharing")
进行访问。
请参阅 Maps JavaScript API 中的库。
构造函数 | |
---|---|
FleetEngineFleetLocationProvider |
FleetEngineFleetLocationProvider(options) 参数:
为 Fleet Engine 跟踪的车辆创建新的位置信息提供程序。 |
属性 | |
---|---|
locationRestriction |
类型:
LatLngBounds|LatLngBoundsLiteral optional 用于跟踪车辆的边界。如果未设置任何边界,系统将不会跟踪任何车辆。如需跟踪所有车辆(无论其位置如何),请将边界设置为相当于整个地球。 |
staleLocationThresholdMillis |
类型:
number 此字段为只读字段。过时车辆位置信息的阈值。如果车辆的上次更新位置信息的时间早于此阈值,则系统不会显示该车辆。 |
vehicleFilter |
类型:
string optional 提取车辆时应用的过滤条件。 |
继承自:
isPolling 、
pollingIntervalMillis
|
方法 | |
---|---|
继承自:
addListener
|
事件 | |
---|---|
update |
function(event) 在 Fleet Engine 数据更新请求完成时触发的事件。 |
继承自:
ispollingchange
|
FleetEngineFleetLocationProviderOptions 接口
google.maps.journeySharing.FleetEngineFleetLocationProviderOptions
接口
车队位置信息提供方的选项。
属性 | |
---|---|
authTokenFetcher |
类型:
AuthTokenFetcher 提供用于向 Fleet Engine 验证客户端身份的 JSON Web 令牌。 |
projectId |
类型:
string Google Cloud 控制台中的消费者的项目 ID。 |
locationRestriction optional |
类型:
LatLngBounds|LatLngBoundsLiteral optional 在位置信息提供程序实例化后立即跟踪车辆的纬度/经度边界。如果未设置,位置信息提供程序不会开始跟踪任何车辆;请使用 FleetEngineFleetLocationProvider.locationRestriction 设置边界并开始跟踪。如需跟踪所有车辆(无论其位置如何),请将边界设置为相当于整个地球。 |
staleLocationThresholdMillis optional |
类型:
number optional 过时车辆位置信息的阈值。如果车辆的上次更新位置信息的时间早于此阈值,则系统不会显示该车辆。默认值为 24 小时(以毫秒为单位)。如果阈值小于零或为 Infinity,系统将忽略该阈值,并且不会将车辆位置视为过时。 |
vehicleFilter optional |
类型:
string optional 在提取车辆时要应用的过滤查询。此过滤条件会直接传递给 Fleet Engine。 如需了解支持的格式,请参阅 ListVehiclesRequest.filter。 请注意,属性的有效过滤条件必须带有“attributes”前缀。例如, attributes.x = "y" 或 attributes."x y" = "z" 。 |
vehicleMarkerCustomization optional |
类型:
function(VehicleMarkerCustomizationFunctionParams): void optional 应用于车辆标记的自定义设置。 使用此字段可指定自定义样式(例如标记图标)和互动性(例如点击处理)。
|
FleetEngineFleetLocationProviderUpdateEvent 接口
google.maps.journeySharing.FleetEngineFleetLocationProviderUpdateEvent
接口
当 FleetEngineFleetLocationProvider.update
事件触发时传递给事件处理程序的事件对象。
属性 | |
---|---|
vehicles optional |
查询返回的车辆列表。不可修改。 |