FleetEngineVehicleLocationProvider class
google.maps.journeySharing.FleetEngineVehicleLocationProvider
class
車輛位置提供者。
這個類別會擴充 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 提供 JSON Web Token,用於向 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 會停用定期位置更新功能。如果位置資訊供應器觀察到的任何參數發生變更,系統就會擷取新的位置資訊更新。 預設的輪詢間隔為 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
class
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 提供 JSON Web Token,用於向 Fleet Engine 驗證用戶端。 |
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 |
查詢傳回的車輛清單。無法修改。 |