Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

DeepSeeUtils

DeepSee を操作するための追加のメソッドを提供します。

このオブジェクトを使用できる場所

このオブジェクトは、クライアント側の JavaScript コード内で使用できます (そのコードで DeepSee.js がインクルードされている場合)。“DeepSee JavaScript API の概要” を参照してください。

このオブジェクトの作成

クライアント・コード内で DeepSee.js をインクルードすると、DeepSeeUtils オブジェクトが自動的に使用可能になります。

このオブジェクトのメソッド

DeepSeeUtils オブジェクトには、以下のメソッドが用意されています。

getCubeList()
getCubeList(connection,finalFunc)

以下はその説明です。

このメソッドは、使用可能なキューブに関する情報を取得します。このメソッドは、POST /Info/Cubes という REST 呼び出しを呼び出します (このドキュメントの次のリファレンスを参照)。この呼び出しの応答オブジェクトは、finalFunc で指定された関数で使用できます。

getCubeListings()
getCubeListings(connection,finalFunc)

以下はその説明です。

  • connection — DeepSee データ・コネクタ・オブジェクト

  • cubename — DeepSee キューブの論理名を指定します。

  • finalFunc — 結果が得られたときに実行する関数の名前を指定します。

このメソッドは、指定されたキューブで使用できるリストに関する情報を取得します。このメソッドは、POST /Info/Listings/:cube という REST 呼び出しを呼び出します (このドキュメントの次のリファレンスを参照)。この呼び出しの応答オブジェクトは、finalFunc で指定された関数で使用できます。

getDashboardList()
getDashboardList(connection,finalFunc)

このメソッドは、使用可能なダッシュボードに関する情報を取得します。このメソッドは、POST /Info/Dashboards という REST 呼び出しを呼び出します (このドキュメントの次のリファレンスを参照)。この呼び出しの応答オブジェクトは、finalFunc で指定された関数で使用できます。

getErrorMessage()
getErrorMessage(data)

ここで、data はいずれかの DeepSee REST サービスによって返された応答オブジェクトです (このドキュメントの次のリファレンスを参照)。

このメソッドは、そのオブジェクトに含まれているエラー・メッセージ (ある場合) のテキストを返します。

getFiltersForDataSource()
getFiltersForDataSource(connection,cubename,finalcallback)

以下はその説明です。

  • connection — DeepSee データ・コネクタ・オブジェクト

  • cubename — DeepSee キューブの論理名を指定します。

  • finalcallback — 結果が得られたときに実行する関数の名前を指定します。

このメソッドは、指定されたキューブで使用できるフィルタに関する情報を取得します。このメソッドは、POST /Info/Filters/:datasource という REST 呼び出しを呼び出します (このドキュメントの次のリファレンスを参照)。この呼び出しの応答オブジェクトは、finalFunc で指定された関数で使用できます。

getMembersForFilter()
getMembersForFilter(connection,cubeName,filterSpec,finalCallback)

以下は値の説明です。

  • connection — DeepSee データ・コネクタ・オブジェクト

  • cubename — DeepSee キューブの論理名を指定します。

  • filterSpec — 取得するメンバが属するフィルタを指定します。

  • finalcallback — 結果が得られたときに実行する関数の名前を指定します。

このメソッドは、指定されたフィルタのメンバに関する情報を取得します。このメソッドは、POST /Info/FilterMembers/:datasource/:filterSpec という REST 呼び出しを呼び出します (このドキュメントの次のリファレンスを参照)。この呼び出しの応答オブジェクトは、finalFunc で指定された関数で使用できます。

getPivotList()
getPivotList(connection,finalFunc)

以下はその説明です。

このメソッドは、使用可能なピボット・テーブルに関する情報を取得します。このメソッドは、POST/Info/Pivots という REST 呼び出しを呼び出します (このドキュメントの次のリファレンスを参照)。この呼び出しの応答オブジェクトは、finalFunc で指定された関数で使用できます。

getResultsAsArray()
getResultsAsArray(data)

ここで、data はいずれかの DeepSee REST サービスによって返された応答オブジェクトです (このドキュメントの次のリファレンスを参照)。

このメソッドは、以下の規則に従ってそのオブジェクト内の結果の配列を返します。

  1. 応答オブジェクトに Result.Filters 配列が含まれている場合は、このメソッドはその配列を返します。

  2. 応答オブジェクトに Result.FilterMembers 配列が含まれている場合は、このメソッドはその配列を返します。

  3. 応答オブジェクトに Result.Listings 配列が含まれている場合は、このメソッドはその配列を返します。

上記のいずれにも該当しない場合は、このメソッドは何も返しません。

isError()
isError(data)

ここで、data はいずれかの DeepSee REST サービスによって返された応答オブジェクトです (このドキュメントの次のリファレンスを参照)。

エラーが発生したことが応答オブジェクトによって示されている場合は、このメソッドは true を返します。そうでない場合は、false を返します。

FeedbackOpens in a new tab