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。このフィールドを設定すると、トラッキングが開始されます。
継承: isPollingpollingIntervalMillis
refresh
refresh()
パラメータ: なし
戻り値:  void
トラッキング中の位置情報を明示的に更新します。
継承: addListener
error
function(event)
引数: 
位置情報プロバイダでエラーが発生したときにトリガーされるイベント。
update
function(event)
Fleet Engine データ更新リクエストが完了したときにトリガーされるイベント。
継承: ispollingchange

FleetEngineTripLocationProviderOptions インターフェース

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

ルート ロケーション プロバイダのオプション。

authTokenFetcher
タイプ:  AuthTokenFetcher
Fleet Engine に対してクライアントを認証するための JSON Web Token を提供します。
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 ミリ秒(最小間隔)です。ポーリング間隔をゼロ以外の小さい値に設定した場合は、5000 が使用されます。
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
更新によって返されたルート構造。変更不可。