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) 参数:
返回值:None
多段线自定义函数,用于根据当前多段线的速度读数为其着色。将此函数指定为 FleetEngineVehicleLocationProviderOptions.activePolylineCustomization ,为活跃多段线渲染交通感知多段线。 |
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION |
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION(params) 参数:
返回值:None
多段线自定义函数,用于根据剩余多段线的速度读数为其着色。将此函数指定为 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 |
提供 JSON Web 令牌,用于向 Fleet Engine 验证客户端的身份。 |
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 会停用定期位置信息更新。如果位置信息提供程序观察到的任何参数发生变化,系统会提取新的位置信息更新。 默认轮询间隔为 5, 000 毫秒,最小间隔。如果将轮询间隔设置为较小的非零值,则使用 5000。 |
remainingPolylineCustomization optional |
类型:
(function(VehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional 自定义内容已应用于其余多段线。剩下的多段线对应于车辆尚未开始穿过的路线的一部分。 使用此字段可以指定自定义样式(例如多段线颜色)和互动性(例如点击处理)。
|
staleLocationThresholdMillis optional |
类型:
number optional 过时车辆位置信息的阈值。如果车辆上次更新的位置信息早于此阈值,则不会显示车辆。默认值为 24 小时(以毫秒为单位)。如果阈值小于 0 或无穷大,则系统会忽略阈值,并且车辆位置信息不会被视为已过时。 |
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
类
舰队位置信息提供程序。
此类扩展了 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 |
提供 JSON Web 令牌,用于向 Fleet Engine 验证客户端的身份。 |
projectId |
类型:
string Google Cloud 控制台中的使用方项目 ID。 |
locationRestriction optional |
类型:
LatLngBounds|LatLngBoundsLiteral optional 在位置提供程序实例化后,用于在此范围内跟踪车辆的纬度/经度边界。如果未设置,位置信息提供程序不会开始跟踪任何车辆;请使用 FleetEngineFleetLocationProvider.locationRestriction 设置边界并开始跟踪。要跟踪所有车辆的位置(无论位置),请设置相当于整个地球的边界。 |
staleLocationThresholdMillis optional |
类型:
number optional 过时车辆位置信息的阈值。如果最近更新的车辆位置早于此阈值,则不会显示这辆车。默认值为 24 小时(以毫秒为单位)。如果阈值小于零或无穷大,则系统会忽略阈值,并且车辆位置信息不会被视为已过时。 |
vehicleFilter optional |
类型:
string optional 在提取车辆时应用的过滤条件查询。此过滤器会直接传递给 Fleet Engine。 如需了解支持的格式,请参阅 ListVehiclesRequest.filter。 请注意,有效的属性过滤条件必须包含“属性”前缀。例如 attributes.x = "y" 或 attributes."x y" = "z" 。 |
vehicleMarkerCustomization optional |
类型:
function(VehicleMarkerCustomizationFunctionParams): void optional 应用于车辆标记的自定义。 您可以使用此字段指定自定义样式(例如标记图标)和互动性(例如点击处理)。
|
FleetEngineFleetLocationProviderUpdateEvent 接口
google.maps.journeySharing.FleetEngineFleetLocationProviderUpdateEvent
接口
触发 FleetEngineFleetLocationProvider.update
事件时传递给事件处理脚本的事件对象。
属性 | |
---|---|
vehicles optional |
查询返回的车辆列表。不可修改。 |