Shipment Tracking

FleetEngineShipmentLocationProvider 類別

class google.maps.journeySharing.FleetEngineShipmentLocationProvider extends PollingLocationProvider, LocationProvider
library "journeySharing"

運送地點供應商。

const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing");
FleetEngineShipmentLocationProvider
FleetEngineShipmentLocationProvider(options)
參數:
為 Fleet Engine 運送追蹤建立新的位置資訊提供者。
trackingId
類型: string
這個位置供應器觀測的工作追蹤 ID。設定這個欄位即可開始追蹤。
繼承: isPolling、pollingIntervalMillis
refresh
refresh()
參數:無
傳回值: void
明確重新整理追蹤的位置。
沿用: addListener
error
function(event)
引數:
位置供應器發生錯誤時觸發的事件。
update
function(event)
Fleet Engine 資料更新要求完成時觸發的事件。
沿用: ispollingchange

FleetEngineShipmentLocationProviderOptions 介面

介面 google.maps.journeySharing.FleetEngineShipmentLocationProviderOptions

運送地點供應商的選項。

authTokenFetcher
提供 JSON Web Token,用於向 Fleet Engine 驗證用戶端。
projectId
類型: string
Google Cloud 控制台中的消費者專案 ID。
activePolylineCustomization
選填
自訂設定已套用至使用中的折線。有效折線對應車輛目前行經的部分路線。

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

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

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

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

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

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

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

預設和最短輪詢時間間隔為 5000 毫秒。如果將輪詢時間間隔設為較低的正值,系統會儲存並使用 5000。
remainingPolylineCustomization
選填
自訂設定已套用至其餘折線。剩餘折線對應車輛尚未開始行經的路線部分。

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

    如需提供的參數清單和用途,請參閱 ShipmentPolylineCustomizationFunctionParams。
takenPolylineCustomization
選填
自訂設定已套用至所選折線。已行駛折線對應至車輛已行經的部分路線。

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

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

FleetEngineShipmentLocationProviderUpdateEvent 介面

介面 google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent

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

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