v5.20191.603
|

ICollectionView インターフェイス

コレクションで現在レコード管理、カスタムのソート、フィルタリング、およびグループ化の機能を実現します。

これはMicrosoftのXAMLプラットフォームで使用される ICollectionView インタフェースのJavaScript版です。 データをUI要素にバインドするための、MVVMを実装しやすい強力で一貫性のある手段を提供します。 Wijmoには、ICollectionView を実装するクラスがいくつか用意されています。 最もよく使用するものはCollectionView で、 これは通常のJavaScript配列に基づいて機能します。

階層

プロパティ

canFilter

canFilter: boolean

このビューがfilter プロパティによってフィルタリングをサポートしているかどうかを示す値を取得します。

canGroup

canGroup: boolean

このビューがgroupDescriptions プロパティによってグループ化をサポートしているかどうかを示す値を取得します。

canSort

canSort: boolean

このビューがsortDescriptions プロパティによってソートをサポートしているかどうかを示す値を取得します。

currentItem

currentItem: any

ビューの現在の項目を取得します。

currentPosition

currentPosition: number

ビューの現在の項目の順序位置を取得します。

filter

filter: IPredicate

項目がビューに含める対象として適しているかどうかを判断するために使用されるコールバックを取得または設定します。

メモ: フィルタ関数でスコープ(すなわち、有効な'this'値)が必要な場合は、 'this'オブジェクトを指定した'bind'関数を使用してフィルタを設定します。以下に例を示しています。

  collectionView.filter = this._filter.bind(this);

groupDescriptions

groupDescriptions: ObservableArray

コレクションの項目をビューでどのようにグループ化するかを記述するGroupDescription オブジェクトのコレクションを取得します。

groups

groups: any[]

最上位レベルのグループを取得します。

isEmpty

isEmpty: boolean

このビューに項目が1つも含まれていないかどうかを示す値を取得します。

items

items: any[]

フィルタリング、ソート、グループ化が適用されたビューの項目を取得します。

sortDescriptions

sortDescriptions: ObservableArray

コレクションの項目をビューでどのようにソートするかを記述するSortDescription オブジェクトのコレクションを取得します。

sourceCollection

sourceCollection: any

このビューの作成元のコレクションオブジェクトを取得または設定します。

メソッド

beginUpdate

  • beginUpdate(): any
  • 次にendUpdate が呼び出されるまで更新を中断します。

    戻り値 any

contains

  • contains(item: any): boolean
  • 指定した項目がこのビューに属するかどうかを示す値を返します。

    引数

    • item: any

      コレクション内で検索する項目。

    戻り値 boolean

deferUpdate

  • deferUpdate(fn: Function): any
  • beginUpdate/endUpdateブロック内で関数を実行します。

    この関数の実行が完了するまでコレクションは更新されません。 このメソッドは、関数が例外を生成した場合でもendUpdate が呼び出されるようにします。

    引数

    • fn: Function

      beginUpdate/endUpdateブロック内で実行する関数。

    戻り値 any

endUpdate

  • endUpdate(): any
  • beginUpdate の呼び出しによって中断された更新を再開します。

    戻り値 any

implementsInterface

  • implementsInterface(interfaceName: string): boolean
  • オブジェクトが指定したインタフェースを実装している場合、trueを返します。

    引数

    • interfaceName: string

      調べるインタフェースの名前。

    戻り値 boolean

moveCurrentTo

  • moveCurrentTo(item: any): boolean
  • 指定した項目をビューの現在の項目に設定します。

    引数

    戻り値 boolean

moveCurrentToFirst

  • moveCurrentToFirst(): boolean
  • ビューの最初の項目を現在の項目として設定します。

    戻り値 boolean

moveCurrentToLast

  • moveCurrentToLast(): boolean
  • ビューの最後の項目を現在の項目として設定します。

    戻り値 boolean

moveCurrentToNext

  • moveCurrentToNext(): boolean
  • ビューの現在の項目の後の項目を現在の項目として設定します。

    戻り値 boolean

moveCurrentToPosition

  • moveCurrentToPosition(index: number): boolean
  • ビューの指定したインデックスにある項目を現在の項目として設定します。

    引数

    • index: number

      currentItem として設定する項目のインデックス。

    戻り値 boolean

moveCurrentToPrevious

  • moveCurrentToPrevious(): any
  • ビューの現在の項目の前の項目を現在の項目として設定します。

    戻り値 any

refresh

  • refresh(): any
  • 現在のソート、フィルタ、およびグループパラメーターを使用してビューを再作成します。

    戻り値 any

イベント

collectionChanged

collectionChanged: Event

Occurs when the collection changes.

currentChanged

currentChanged: Event

Occurs after the current item changes.

currentChanging

currentChanging: Event

Occurs before the current item changes.