5.20193.637
WjFlexGridDetail Wijmo API クラス

WjFlexGridDetail クラス

FlexGrid DetailRow テンプレートに対応するAngular 2ディレクティブ。

wj-flex-grid-detailディレクティブは、wj-flex-gridコンポーネントに含まれる <template>テンプレート要素で指定する必要があります。

wj-flex-grid-detailディレクティブは、詳細行の表示状態を保持する FlexGridDetailProvider クラスから派生され、詳細行のコンテンツは、 任意のHTMLフラグメントとしてディレクティブタグ内で定義されます。フラグメントには、 Angular 2連結、コンポーネント、およびディレクティブを含めることができます。 rowおよび itemテンプレート変数をAngular 2連結で使用して、 詳細行の親Row およびRow.dataItemオブジェクトを参照できます。

階層

プロパティ

createDetailCell

createDetailCell: ICreateDetailCell

詳細セルを作成するためのコールバック関数を取得または設定します。

このコールバック関数は、パラメータとしてRow を受け取り、 行詳細を表すHTML要素を返します。 次に例を示します。

// 指定された行の詳細セルを作成します
dp.createDetailCell = function (row) {
  var cell = document.createElement('div');
  var detailGrid = new wijmo.grid.FlexGrid(cell, {
    itemsSource: getProducts(row.dataItem.CategoryID),
    headersVisibility: wijmo.grid.HeadersVisibility.Column
  });
  return cell;
};

detailVisibilityMode

detailVisibilityMode: DetailVisibilityMode

行詳細をいつ表示するかを決定する値を取得または設定します。

このプロパティのデフォルト値はDetailVisibilityMode.ExpandSingleです。

disposeDetailCell

disposeDetailCell: IDisposeDetailCell

詳細セルを破棄するためのコールバック関数を取得または設定します。

このコールバック関数は、パラメータとしてRow を受け取り、 詳細セルに関連付けられているすべてのリソースを破棄します。

この関数はオプションです。この関数は、自動的に ガベージコレクトされないリソースをcreateDetailCell 関数で 割り当てている場合に使用します。

grid

grid: FlexGrid

このFlexGridDetailProvider を所有するFlexGrid を取得します。

initialized

initialized: EventEmitter<any>

このイベントは、コンポーネントがAngularによって初期化された後、つまり すべての連結プロパティが割り当てられ、子コンポーネント(ある場合)が初期化された後にトリガされます。

isAnimated

isAnimated: boolean

行詳細を表示するときにアニメーションを使用するかどうかを示す値を取得または設定します。

このプロパティのデフォルト値はfalse です。

isInitialized

isInitialized: boolean

コンポーネントがAngularによって初期化されているかどうかを示します。 この値は、initializedイベントをトリガする直前にfalseからtrueになります。

keyActionEnter

keyActionEnter: KeyAction

[ENTER]キーが押されたときに実行されるアクションを取得または設定します。

このプロパティのデフォルト設定はKeyAction.None です。 これにより、グリッドはキーを処理できます。 そしてKeyAction.ToggleDetail により、Enterキーを操作して詳細行の表示を切り替えます。

maxHeight

maxHeight: number

詳細行の最大高さをピクセル単位で取得または設定します。

このプロパティのデフォルト値はnull, です。 この場合、詳細行の高さに上限はありません。

rowHasDetail

rowHasDetail: IRowHasDetail

行に詳細があるかどうかを判定するためのコールバック関数を取得または設定します。

このコールバック関数は、パラメータとしてRow を受け取り、 行に詳細があるかどうかを示すブール値を返します。次に例を示します。

// 奇数のCategoryIDを持つ項目から詳細を削除します
dp.rowHasDetail = function (row) {
  return row.dataItem.CategoryID % 2 == 0;
};

このプロパティをnullに設定すると、すべての行に詳細が含まれます。

メソッド

created

  • created(): void
  • Wijmoコンポーネントから継承されるカスタムコンポーネントを作成する場合は、このメソッドを
    オーバーライドして、通常はクラスコンストラクタで行う必要な初期化を行うことができます。 このメソッドは、Wijmoコンポーネントコンストラクタの最後の行で呼び出され、 カスタムコンポーネントのコンストラクタを宣言しなくて済むようにします。これにより、 コンストラクタのパラメータを保持したり、Wijmoコンポーネントのコンストラクタパラメータとの同期を維持する必要がなくなります。

    戻り値 void

getDetailRow

  • 指定したグリッド行に関連付けられた詳細行を取得します。

    引数

    • row: any

      調査する行または行のインデックス。

    戻り値 DetailRow

hideDetail

  • hideDetail(row?: any): void
  • 指定された行の詳細行を非表示にします。

    引数

    • オプション row: any

      詳細が非表示になっている行または行のインデックス。このパラメータはオプションです。 指定されない場合は、すべての詳細行が非表示になります。

    戻り値 void

isDetailAvailable

  • isDetailAvailable(row: any): boolean
  • 行に表示する詳細があるかどうかを決定する値を取得します。

    引数

    • row: any

      調査する行または行のインデックス。

    戻り値 boolean

isDetailVisible

  • isDetailVisible(row: any): boolean
  • 行の詳細を表示するかどうかを決定する値を取得します。

    引数

    • row: any

      調査する行または行のインデックス。

    戻り値 boolean

showDetail

  • showDetail(row: any, hideOthers?: boolean): void
  • 指定された行の詳細行を表示します。

    引数

    • row: any

      詳細が表示されている行または行のインデックス。

    • オプション hideOthers: boolean

      他のすべての行の詳細を非表示にするかどうか。

    戻り値 void