Trip and Order Progress

FleetEngineTripLocationProvider クラス

google.maps.journeySharing.FleetEngineTripLocationProvider クラス

乗車位置情報プロバイダ。

このクラスは PollingLocationProvider を拡張します。

const {FleetEngineTripLocationProvider} = await google.maps.importLibrary("journeySharing") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
FleetEngineTripLocationProvider
FleetEngineTripLocationProvider(options)
パラメータ: 
Fleet Engine の乗車用に新しい位置情報プロバイダを作成します。
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION(params)
パラメータ: 
戻り値: なし
アクティブなポリラインを速読の速度に応じて色付けするポリラインのカスタマイズ関数。この関数を FleetEngineTripLocationProviderOptions.activePolylineCustomization として指定すると、アクティブなポリラインの交通状況を考慮したポリラインがレンダリングされます。
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION(params)
パラメータ: 
戻り値: なし
残りのポリラインを速読の速度に応じて色付けするポリラインのカスタマイズ関数。この関数を FleetEngineTripLocationProviderOptions.remainingPolylineCustomization として指定して、残りのポリラインの交通状況を考慮したポリラインをレンダリングします。
tripId
タイプ:  string
この位置情報プロバイダが監視する旅行の ID。このフィールドを設定して、トラッキングを開始します。
継承: isPolling、 pollingIntervalMillis
refresh
refresh()
パラメータ: なし
戻り値:  void
追跡対象のビジネスを明示的に更新します。
継承: addListener
error
function(event)
引数: 
位置情報プロバイダでエラーが発生したときにトリガーされるイベント。
update
function(event)
引数: 
Fleet Engine データ更新リクエストが完了したときにトリガーされるイベント。
継承: ispollingchange

FleetEngineTripLocationProviderOptions インターフェース

google.maps.journeySharing.FleetEngineTripLocationProviderOptions インターフェース

旅行のロケーション プロバイダのオプション。
authTokenFetcher
タイプ:  AuthTokenFetcher
Fleet Engine に対してクライアントを認証するための JSON ウェブトークンを提供します。
projectId
タイプ:  string
Google Cloud コンソールから取得したコンシューマーのプロジェクト ID。
activePolylineCustomization optional
タイプ:  (function(TripPolylineCustomizationFunctionParams): void)|PolylineOptions optional
アクティブなポリラインに適用されたカスタマイズ。アクティブなポリラインは、車両が現在走行しているルートの一部に対応します。

このフィールドを使用して、カスタム スタイル（ポリラインの色など）とインタラクティビティ（クリック処理など）を指定します。
  • PolylineOptions オブジェクトが指定されている場合、そのオブジェクトで指定された変更は、ポリラインの作成後にポリラインに適用され、デフォルトのオプションが存在する場合は上書きされます。
  • 関数が指定されている場合は、ポリラインの作成時に 1 回呼び出されます。（この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます）。また、この関数は、ポリラインの座標が変更されたとき、またはこのポリラインに対応するデータが変更されたかどうかにかかわらず、位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。

    指定されたパラメータとその使用方法の一覧については、TripPolylineCustomizationFunctionParams をご覧ください。
destinationMarkerCustomization optional
タイプ:  (function(TripMarkerCustomizationFunctionParams): void)|MarkerOptions optional
目的地マーカーに適用されるカスタマイズ。

このフィールドを使用して、カスタム スタイル（マーカー アイコンなど）とインタラクティビティ（クリック処理など）を指定します。
  • MarkerOptions オブジェクトが指定されている場合、マーカーの作成後に、そのオブジェクトで指定された変更がマーカーに適用され、デフォルトのオプションが存在する場合は上書きされます。
  • 関数が指定されている場合、マーカーが作成されたときに、マップビューに追加される前に 1 回呼び出されます。（この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます）。また、この関数は、このマーカーに対応するデータが変更されたかどうかに関係なく、位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。

    指定されたパラメータとその使用方法の一覧については、TripMarkerCustomizationFunctionParams をご覧ください。
originMarkerCustomization optional
タイプ:  (function(TripMarkerCustomizationFunctionParams): void)|MarkerOptions optional
出発地のマーカーに適用されるカスタマイズ。

このフィールドを使用して、カスタム スタイル（マーカー アイコンなど）とインタラクティビティ（クリック処理など）を指定します。
  • MarkerOptions オブジェクトが指定されている場合、マーカーの作成後に、そのオブジェクトで指定された変更がマーカーに適用され、デフォルトのオプションが存在する場合は上書きされます。
  • 関数が指定されている場合、マーカーが作成されたときに、マップビューに追加される前に 1 回呼び出されます。（この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます）。また、この関数は、このマーカーに対応するデータが変更されたかどうかに関係なく、位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。

    指定されたパラメータとその使用方法の一覧については、TripMarkerCustomizationFunctionParams をご覧ください。
pollingIntervalMillis optional
タイプ:  number optional
位置情報の更新を取得する最小間隔（ミリ秒単位）。位置情報の更新の取得に pollingIntervalMillis より長い時間がかかる場合、次の位置情報の更新は現在の更新が完了するまで開始されません。

この値を 0 に設定すると、定期的な位置情報の更新が無効になります。位置情報プロバイダによって監視されているパラメータのいずれかが変更されると、新しい位置情報の更新が取得されます。

デフォルトのポーリング間隔は 5, 000 ミリ秒（最小間隔）です。ポーリング間隔をゼロ以外の小さい値に設定すると、5, 000 が使用されます。
remainingPolylineCustomization optional
タイプ:  (function(TripPolylineCustomizationFunctionParams): void)|PolylineOptions optional
残りのポリラインに適用されたカスタマイズ。残りのポリラインは、車両がまだ通過していないルートの一部に対応します。

このフィールドを使用して、カスタム スタイル（ポリラインの色など）とインタラクティビティ（クリック処理など）を指定します。
  • PolylineOptions オブジェクトが指定されている場合、そのオブジェクトで指定された変更は、ポリラインの作成後にポリラインに適用され、デフォルトのオプションが存在する場合は上書きされます。
  • 関数が指定されている場合は、ポリラインの作成時に 1 回呼び出されます。（この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます）。また、この関数は、ポリラインの座標が変更されたとき、またはこのポリラインに対応するデータが変更されたかどうかにかかわらず、位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。

    指定されたパラメータとその使用方法の一覧については、TripPolylineCustomizationFunctionParams をご覧ください。
takenPolylineCustomization optional
タイプ:  (function(TripPolylineCustomizationFunctionParams): void)|PolylineOptions optional
取得したポリラインに適用されたカスタマイズ。取得済みのポリラインは、車両がすでに通過したルートの一部に対応します。

このフィールドを使用して、カスタム スタイル（ポリラインの色など）とインタラクティビティ（クリック処理など）を指定します。
  • PolylineOptions オブジェクトが指定されている場合、そのオブジェクトで指定された変更は、ポリラインの作成後にポリラインに適用され、デフォルトのオプションが存在する場合は上書きされます。
  • 関数が指定されている場合は、ポリラインの作成時に 1 回呼び出されます。（この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます）。また、この関数は、ポリラインの座標が変更されたとき、またはこのポリラインに対応するデータが変更されたかどうかにかかわらず、位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。

    指定されたパラメータとその使用方法の一覧については、TripPolylineCustomizationFunctionParams をご覧ください。
tripId optional
タイプ:  string optional
位置情報プロバイダのインスタンス化直後に追跡する乗車 ID。指定しない場合、位置情報プロバイダは乗車を追跡しません。FleetEngineTripLocationProvider.tripId を使用して ID を設定し、追跡を開始します。
vehicleMarkerCustomization optional
タイプ:  (function(TripMarkerCustomizationFunctionParams): void)|MarkerOptions optional
車両マーカーに適用されるカスタマイズ。

このフィールドを使用して、カスタム スタイル（マーカー アイコンなど）とインタラクティビティ（クリック処理など）を指定します。
  • MarkerOptions オブジェクトが指定されている場合、マーカーの作成後に、そのオブジェクトで指定された変更がマーカーに適用され、デフォルトのオプションが存在する場合は上書きされます。
  • 関数が指定されている場合、マーカーが作成されたときに、マップビューに追加される前に 1 回呼び出されます。（この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます）。また、この関数は、このマーカーに対応するデータが変更されたかどうかに関係なく、位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。

    指定されたパラメータとその使用方法の一覧については、TripMarkerCustomizationFunctionParams をご覧ください。
waypointMarkerCustomization optional
タイプ:  (function(TripWaypointMarkerCustomizationFunctionParams): void)|MarkerOptions optional
経由地マーカーに適用されたカスタマイズ。

このフィールドを使用して、カスタム スタイル（マーカー アイコンなど）とインタラクティビティ（クリック処理など）を指定します。
  • MarkerOptions オブジェクトが指定されている場合、マーカーの作成後に、そのオブジェクトで指定された変更がマーカーに適用され、デフォルトのオプションが存在する場合は上書きされます。
  • 関数が指定されている場合、マーカーが作成されたときに、マップビューに追加される前に 1 回呼び出されます。（この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます）。また、この関数は、このマーカーに対応するデータが変更されたかどうかに関係なく、位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。

    指定されたパラメータとその使用方法の一覧については、TripWaypointMarkerCustomizationFunctionParams をご覧ください。

FleetEngineTripLocationProviderUpdateEvent インターフェース

google.maps.journeySharing.FleetEngineTripLocationProviderUpdateEvent インターフェース

FleetEngineTripLocationProvider.update イベントがトリガーされたときにイベント ハンドラに渡されるイベント オブジェクト。
trip optional
タイプ:  Trip optional
更新によって返される乗車構造。変更不可。