Trip and Order Progress

FleetEngineTripLocationProvider クラス

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

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

const {FleetEngineTripLocationProvider} = await google.maps.importLibrary("journeySharing");
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
省略可
タイプ: (function(TripPolylineCustomizationFunctionParams): void)|PolylineOptions optional
アクティブなポリラインに適用されるカスタマイズ。アクティブなポリラインは、車両が現在走行しているルートの一部に対応します。

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

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

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

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

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

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

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

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

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

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

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

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

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

    指定されたパラメータとその用途の一覧については、TripMarkerCustomizationFunctionParams をご覧ください。
waypointMarkerCustomization
省略可
タイプ: (function(TripWaypointMarkerCustomizationFunctionParams): void)|MarkerOptions optional
ウェイポイント マーカーに適用されるカスタマイズ。

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

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

FleetEngineTripLocationProviderUpdateEvent インターフェース

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

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