Shipment Tracking

FleetEngineShipmentLocationProvider 類別

google.maps.journeySharing.FleetEngineShipmentLocationProvider 類別

出貨地點供應商。

這個類別會擴充 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)。此外,無論此標記對應的資料是否有所變更,函式參數物件中的 isNew 參數都會在 Fleet Engine 接收資料時叫用。

    如需提供的參數清單及其用途,請參閱 ShipmentMarkerCustomizationFunctionParams
destinationMarkerCustomization optional
類型:  (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional
自訂已套用至目的地標記。

請使用這個欄位指定自訂樣式 (例如標記圖示) 和互動功能 (例如點擊處理)。
  • 如果指定 MarkerOptions 物件,則標記中指定的變更會在標記建立後套用至標記,而如果標記存在,則會覆寫其預設選項。
  • 如果指定函式,系統會在建立標記時呼叫該函式一次,之後才會將其加入地圖檢視。(在此叫用中,函式參數物件中的 isNew 參數會設為 true)。此外,無論此標記對應的資料是否有所變更,函式參數物件中的 isNew 參數都會在 Fleet Engine 接收資料時叫用。

    如需提供的參數清單及其用途,請參閱 ShipmentMarkerCustomizationFunctionParams
pollingIntervalMillis optional
類型:  number optional
擷取位置更新作業之間的最短時間 (以毫秒為單位)。如果擷取位置資訊更新的時間超過 pollingIntervalMillis,則系統必須等到目前的位置更新作業完成後,才會啟動下一次位置更新作業。

如果將這個值設為 0、Infinity 或負值,就會停用位置自動更新功能。如果追蹤 ID 參數 (例如運送地點供應商的運送追蹤 ID) 或篩選選項 (例如機群位置供應商的可視區域邊界或屬性篩選器) 有所變更,系統就會擷取一次新的位置更新通知。

預設的輪詢時間間隔為 5000 毫秒。如果將輪詢時間間隔設為較低的正值,系統就會儲存並使用 5, 000。
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
更新傳回的工作追蹤資訊結構。無法修改。