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?

DeepSeeDataController

DeepSee データ・ソースを操作することを可能にします。

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

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

このオブジェクトの作成

DeepSee データ・コントローラ・オブジェクトを作成するには、次のようなコードを使用します。

var controller = new DeepSeeDataController(configuration,finalCallback,pendingCallback);

以下は値の説明です。

  • configuration は、以下のプロパティを持つオブジェクトです。

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

    • widget — データ・コントローラを使用するページ上の HTML 要素の ID を指定します。

    • type — データ・ソースのタイプとして 'MDX' または 'PIVOT' を指定します (大文字と小文字が区別されます)。

    • initialMDX — MDX SELECT クエリを指定します (このプロパティは type'MDX' の場合に指定します)。

    • pivotName — ピボット・テーブルの論理名を指定します (このプロパティは type'PIVOT' の場合に指定します)。

    • showTotals — 合計を表示するのかどうかを指定します。このプロパティには true または false を指定します。

  • finalCallback は、このページ上のコールバック関数の名前です。

    このオブジェクトの runQuery() などのメソッドについては、クエリが完了すると、DeepSee はこの関数を呼び出します。

  • pendingCallback (オプション) は、このページ上のもう 1 つのコールバック関数の名前です。

    このオブジェクトの runQuery() などのメソッドについては、保留中の結果が得られたときに、DeepSee はこの関数を呼び出します (この引数が指定されている場合)。

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

DeepSee データ・コントローラ・オブジェクトには、以下の JavaScript メソッドがあります。

applyFilter()
applyFilter(filterInfo)

ここで、filterInfofilterName プロパティと filterSpec プロパティが含まれたオブジェクトです。

このメソッドは、データ・コントローラで使用されているフィルタに指定フィルタを追加して、クエリを再実行してから、データ・コントローラ・オブジェクトに関連付けられているコールバック関数を呼び出します。

このメソッドには戻り値はありません。

attachTotals()
attachTotals(rowTotals,columnTotals,reattach)

以下はその説明です。

  • rowTotals には、行の合計をアタッチするかどうかに応じて true または false を指定します。

  • columnTotals には、列の合計をアタッチするかどうかに応じて true または false を指定します。

  • reattach には、最後に保存された状態を更新するかどうかに応じて true または false を指定します。

    reattachtrue の場合は、DeepSee は最後に保存された状態を更新します。reattachfalse の場合は、DeepSee は新しい状態オブジェクトをスタックに追加します。

このメソッドは、データ・コントローラ・オブジェクトに合計をアタッチしてから、データ・コントローラ・オブジェクトに関連付けられているコールバック関数を呼び出します。

このメソッドには戻り値はありません。

getCurrentData()
getCurrentData()

DeepSee 結果セット・オブジェクトを返します。このオブジェクトには、データ・コントローラ・オブジェクトによって現在定義されているクエリの結果が含まれています。DeepSeeResultSet オブジェクトのリファレンス情報を参照してください。

getCurrentQueryText()
getCurrentQueryText()

データ・コントローラ・オブジェクトで現在定義されているクエリのテキストを返します。

runDrillDown()
runDrillDown(axis, position)

以下はその説明です。

  • axis は、ドリルダウン操作を実行する軸の番号です。列の場合は 1 を指定し、行の場合は 2 を指定します。

  • position は、指定された軸上のドリルダウン操作を実行する位置 (先頭は 1) です。

このメソッドは、指定されたドリルダウン操作を実行してから、データ・コントローラ・オブジェクトに関連付けられているコールバック関数を呼び出します。

このメソッドには戻り値はありません。

runListing()
runListing(startRow, startCol, endRow, endCol, listingName)

以下はその説明です。

  • startRowstartCol は、詳細リストを希望する結果の最初の行と列の番号です。先頭の行または列の場合は 1 を指定します。

  • endRowendCol は、詳細リストを希望する最後の行と列の番号です。

  • listingName は、詳細リストの論理名です。

このメソッドは、結果の 1 つ以上のセルについて指定された詳細リストを実行してから、データ・コントローラ・オブジェクトに関連付けられているコールバック関数を呼び出します。

このメソッドには戻り値はありません。

runQuery()
runQuery()

データ・コントローラ・オブジェクトで現在定義されているクエリを実行します。このクエリが保留中のときや完了したときは、DeepSee はデータ・コントローラ・オブジェクトに関連付けられているコールバック関数を呼び出します。

このメソッドには戻り値はありません。

sortResults()
sortResults(axis, position, direction, sortType)

以下はその説明です。

  • axis は、ソートする軸の番号です。列の場合は 1 を指定し、行の場合は 2 を指定します。

  • position は、ソートする当該軸上の位置 (先頭は 1) です。

    例えば、3 列目を基準にしてソートするには、axis に 1 を指定し、position に 3 を指定します。

  • direction は、ソートする方向です。昇順でソートするには 1 を指定し、降順でソートするには -1 を指定します。

  • sortType は、ソート方法を指定します。この値が '' または 'numeric' (大文字と小文字は区別されません) である場合は、数値ソートが実行されます。それ以外の場合は、文字列ソートが実行されます。

このメソッドは、指定されたとおりに結果をソートしてから、データ・コントローラ・オブジェクトに関連付けられているコールバック関数を呼び出します。

このメソッドには戻り値はありません。

undoLastAction()
undoLastAction()

最後に加えられた変更を元に戻してから、データ・コントローラ・オブジェクトに関連付けられているコールバック関数を呼び出します。

このメソッドには戻り値はありません。

FeedbackOpens in a new tab