Shipment Tracking

FleetEngineShipmentLocationProvider 類別

google.maps.journeySharing.FleetEngineShipmentLocationProvider class

運送地點提供者。

這個類別會擴充 PollingLocationProvider

請呼叫 const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing") 存取。請參閱「Maps JavaScript API 中的程式庫」。

FleetEngineShipmentLocationProvider
FleetEngineShipmentLocationProvider(options)
參數: 
建立新的地點供應器,用於追蹤 Fleet Engine 貨件。
trackingId
類型:  string
此位置資訊供應器觀察到的任務追蹤 ID。設定這個欄位即可開始追蹤。
繼承: isPollingpollingIntervalMillis
refresh
refresh()
參數:
傳回值:  void
明確重新整理追蹤位置。
繼承: addListener
error
function(event)
引數: 
當位置提供者發生錯誤時觸發的事件。
update
function(event)
當 Fleet Engine 資料更新要求完成時,系統會觸發這項事件。
繼承: ispollingchange

FleetEngineShipmentLocationProviderOptions 介面

google.maps.journeySharing.FleetEngineShipmentLocationProviderOptions 介面

運送地點供應器的選項。

authTokenFetcher
類型:  AuthTokenFetcher
提供 JSON Web Token,用於向 Fleet Engine 驗證用戶端。
projectId
類型:  string
消費者的 Google Cloud 控制台專案 ID。
activePolylineCustomization optional
類型:  (function(ShipmentPolylineCustomizationFunctionParams): void)|PolylineOptions optional
已套用至有效折線的自訂項目。有效的多邊形線會對應至車輛目前行經路線的一部分。

請使用這個欄位指定自訂樣式 (例如多邊形顏色) 和互動功能 (例如點擊處理)。
  • 如果指定 PolylineOptions 物件,系統會在建立折線後套用其中指定的變更,並覆寫其預設選項 (如有)。
  • 如果指定函式,系統會在建立多邊形時呼叫該函式一次。(在這個呼叫中,函式參數物件中的 isNew 參數會設為 true)。此外,無論與此多邊形對應的資料是否已變更,只要多邊形的座標變更,或位置提供者收到 Fleet Engine 的資料,就會叫用這個函式。

    如需提供參數和用途的清單,請參閱 ShipmentPolylineCustomizationFunctionParams
deliveryVehicleMarkerCustomization optional
類型:  (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional
套用自訂項目至運送車輛標記。

您可以使用這個欄位指定自訂樣式 (例如標記圖示) 和互動功能 (例如點擊處理)。
  • 如果指定 MarkerOptions 物件,系統會在標記建立後套用其中指定的變更,並覆寫標記的預設選項 (如果有)。
  • 如果指定函式,系統會在建立標記時呼叫該函式一次,然後再將標記加入地圖檢視畫面。(在這個叫用作業中,函式參數物件中的 isNew 參數會設為 true)。此外,無論與此標記相對應的資料是否已變更,位置供應器接收 Fleet Engine 的資料時,都會叫用這個函式。

    如要查看提供的參數和用途清單,請參閱 ShipmentMarkerCustomizationFunctionParams
destinationMarkerCustomization optional
類型:  (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional
套用至目的地標記的自訂項目。

您可以使用這個欄位指定自訂樣式 (例如標記圖示) 和互動功能 (例如點擊處理)。
  • 如果指定 MarkerOptions 物件,系統會在標記建立後套用其中指定的變更,並覆寫標記的預設選項 (如果有)。
  • 如果指定函式,系統會在建立標記時呼叫該函式一次,然後再將標記加入地圖檢視畫面。(在這個叫用作業中,函式參數物件中的 isNew 參數會設為 true)。此外,無論與此標記相對應的資料是否已變更,位置供應器接收 Fleet Engine 的資料時,都會叫用這個函式。

    如要查看提供的參數和用途清單,請參閱 ShipmentMarkerCustomizationFunctionParams
pollingIntervalMillis optional
類型:  number optional
擷取位置更新之間的最短時間 (以毫秒為單位)。如果擷取位置更新的時間超過 pollingIntervalMillis,系統會等到目前的更新完成後,才開始下一個位置更新。

將這個值設為 0、Infinity 或負值,會停用自動位置更新功能。如果追蹤 ID 參數 (例如運送位置供應商的運送追蹤 ID) 或篩選選項 (例如車隊位置供應商的檢視區範圍或屬性篩選器) 有所變更,系統就會擷取新的地點更新。

預設的輪詢間隔為 5000 毫秒,也是最短的輪詢間隔。如果您將輪詢間隔設為較低的正值,系統會儲存並使用 5000。
remainingPolylineCustomization optional
類型:  (function(ShipmentPolylineCustomizationFunctionParams): void)|PolylineOptions optional
自訂項目套用至剩餘的折線。剩餘的折線對應至車輛尚未開始穿越的路線部分。

請使用這個欄位指定自訂樣式 (例如多邊形顏色) 和互動功能 (例如點擊處理)。
  • 如果指定 PolylineOptions 物件,系統會在建立折線後套用其中指定的變更,並覆寫其預設選項 (如有)。
  • 如果指定函式,系統會在建立多邊形時呼叫該函式一次。(在這個呼叫中,函式參數物件中的 isNew 參數會設為 true)。此外,無論與此多邊形對應的資料是否已變更,只要多邊形的座標變更,或位置提供者收到 Fleet Engine 的資料,就會叫用這個函式。

    如需提供參數和用途的清單,請參閱 ShipmentPolylineCustomizationFunctionParams
takenPolylineCustomization optional
類型:  (function(ShipmentPolylineCustomizationFunctionParams): void)|PolylineOptions optional
已套用自訂化至拍攝的折線。已行經的折線會對應至車輛已行經的路線部分。

請使用這個欄位指定自訂樣式 (例如多邊形顏色) 和互動功能 (例如點擊處理)。
  • 如果指定 PolylineOptions 物件,系統會在建立折線後套用其中指定的變更,並覆寫其預設選項 (如有)。
  • 如果指定函式,系統會在建立多邊形時呼叫該函式一次。(在這個呼叫中,函式參數物件中的 isNew 參數會設為 true)。此外,無論與此多邊形對應的資料是否已變更,只要多邊形的座標變更,或位置提供者收到 Fleet Engine 的資料,就會叫用這個函式。

    如需提供參數和用途的清單,請參閱 ShipmentPolylineCustomizationFunctionParams
trackingId optional
類型:  string optional
在位置供應器例項化後立即追蹤的追蹤 ID。如果未指定,位置供應器就不會開始追蹤任何工作;請使用 FleetEngineShipmentLocationProvider.trackingId 設定追蹤 ID 並開始追蹤。

FleetEngineShipmentLocationProviderUpdateEvent 介面

google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent 介面

觸發 FleetEngineShipmentLocationProvider.update 事件時,傳遞至事件處理常式的事件物件。

taskTrackingInfo optional
類型:  TaskTrackingInfo optional
更新傳回的工作追蹤資訊結構。無法修改。