Client-Side API Reference > CollectionView > ICollectionView Interface |
Gets a value that indicates whether this view supports filtering via the filter property.
Gets a value that indicates whether this view supports grouping via the groupDescriptions property.
Gets a value that indicates whether this view supports sorting via the sortDescriptions property.
Gets the current item in the view.
Gets or sets a callback used to determine if an item is suitable for inclusion in the view.
NOTE: If the filter function needs a scope (i.e. a meaningful 'this' value), then remember to set the filter using the 'bind' function to specify the 'this' object. For example:
collectionView.filter = this._filter.bind(this);
Gets a collection of GroupDescription objects that describe how the items in the collection are grouped in the view.
Gets the top-level groups.
Gets the filtered, sorted, grouped items in the view.
Gets a collection of SortDescription objects that describe how the items in the collection are sorted in the view.
Gets or sets the collection object from which to create this view.
contains(item: any): boolean
Returns a value that indicates whether a given item belongs to this view.
The item to locate in the collection.
deferUpdate(fn: Function): void
Executes a function within a beginUpdate/endUpdate block.
The collection will not be refreshed until the function has been executed. This method ensures endUpdate is called even if the function throws.
Function to be executed within the beginUpdate/endUpdate block.
moveCurrentTo(item: any): boolean
Sets the specified item to be the current item in the view.
The item to set as the currentItem.
moveCurrentToFirst(): boolean
Sets the first item in the view as the current item.
moveCurrentToLast(): boolean
Sets the last item in the view as the current item.
moveCurrentToNext(): boolean
Sets the item after the current item in the view as the current item.
moveCurrentToPosition(index: number): boolean
Sets the item at the specified index in the view as the current item.
moveCurrentToPrevious(): void
Sets the item before the current item in the view as the current item.
refresh(): void
Re-creates the view using the current sort, filter, and group parameters.
Enables collections to have the functionalities of current record management, custom sorting, filtering, and grouping.
This is a JavaScript version of the ICollectionView interface used in Microsoft's XAML platform. It provides a consistent, powerful, and MVVM-friendly way to bind data to UI elements.
Wijmo includes several classes that implement ICollectionView. The most common is CollectionView, which works based on regular JavsScript arrays.