ASP.NET MVC Controls
ICollectionView Interface
File
wijmo.js
Module
wijmo.collections
Implements
INotifyCollectionChanged

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.

Properties

Methods

Properties

canFilter

Gets a value that indicates whether this view supports filtering via the filter property.

Type
boolean

canGroup

Gets a value that indicates whether this view supports grouping via the groupDescriptions property.

Type
boolean

canSort

Gets a value that indicates whether this view supports sorting via the sortDescriptions property.

Type
boolean

currentChanged

Occurs after the current item changes.

Type
Event

currentChanging

Occurs before the current item changes.

Type
Event

currentItem

Gets the current item in the view.

Type
any

currentPosition

Gets the ordinal position of the current item in the view.

Type
number

filter

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);
Type
IPredicate

groupDescriptions

Gets a collection of GroupDescription objects that describe how the items in the collection are grouped in the view.

Type
ObservableArray

groups

Gets the top-level groups.

Type
any[]

isEmpty

Gets a value that indicates whether this view contains no items.

Type
boolean

items

Gets the filtered, sorted, grouped items in the view.

Type
any[]

sortDescriptions

Gets a collection of SortDescription objects that describe how the items in the collection are sorted in the view.

Type
ObservableArray

sourceCollection

Gets or sets the collection object from which to create this view.

Type
any

Methods

beginUpdate

beginUpdate(): void

Suspends refreshes until the next call to endUpdate.

Returns
void

contains

contains(item: any): boolean

Returns a value that indicates whether a given item belongs to this view.

Parameters
  • item: any

    The item to locate in the collection.

Returns
boolean

deferUpdate

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.

Parameters
  • fn: Function

    Function to be executed within the beginUpdate/endUpdate block.

Returns
void

endUpdate

endUpdate(): void

Resumes refreshes suspended by a call to beginUpdate.

Returns
void

moveCurrentTo

moveCurrentTo(item: any): boolean

Sets the specified item to be the current item in the view.

Parameters
Returns
boolean

moveCurrentToFirst

moveCurrentToFirst(): boolean

Sets the first item in the view as the current item.

Returns
boolean

moveCurrentToLast

moveCurrentToLast(): boolean

Sets the last item in the view as the current item.

Returns
boolean

moveCurrentToNext

moveCurrentToNext(): boolean

Sets the item after the current item in the view as the current item.

Returns
boolean

moveCurrentToPosition

moveCurrentToPosition(index: number): boolean

Sets the item at the specified index in the view as the current item.

Parameters
Returns
boolean

moveCurrentToPrevious

moveCurrentToPrevious(): void

Sets the item before the current item in the view as the current item.

Returns
void

refresh

refresh(): void

Re-creates the view using the current sort, filter, and group parameters.

Returns
void

 

 


Copyright © GrapeCity, inc. All rights reserved.

Product Support Forum |  Documentation Feedback