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 ミリ秒で、最小間隔です。ポーリング間隔をゼロ以外の小さい値に設定すると、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
更新情報によって返されるルートの構造。変更できません。