- Interops
-
Wijmo
- Aggregate
- Arraybase
- Barcode
- Binding
- Canceleventargs
- Chart
- Clipboard
- Cloud
- Collectionview
- Collectionviewgroup
- Color
- Control
- Datatype
- Datetime
- Event
- Eventargs
- Gauge
- Globalize
- Grid
- Groupdescription
- Ibindinginfo
- Icollectionview
- Ieditablecollectionview
- Ihttprequestoptions
- Inotifycollectionchanged
- Input
- Interop
-
Ipagedcollectionview
- Iqueryinterface
- Key
- Nav
- Notifycollectionchangedaction
- Notifycollectionchangedeventargs
- Observablearray
- Odata
- Olap
- Pagechangingeventargs
- Point
- Popupposition
- Printdocument
- Propertychangedeventargs
- Propertygroupdescription
- Rect
- Requesterroreventargs
- Rest
- Size
- Sortdescription
- Sortnulls
- Tooltip
- Tooltipeventargs
- Tooltiptrigger
- Touch
- Undo
- Viewer
- Xlsx
Wijmo.Ipagedcollectionview
IPagedCollectionView Interface
Type parameters
-
T
Heirarchy
-
ICollectionView
- IPagedCollectionView
Implemented by
Properties
Methods
Events
Properties
canChangePage
Gets a value that indicates whether the pageIndex value can change.
canFilter
Gets a value that indicates whether this view supports filtering via the filter property.
canGroup
Gets a value that indicates whether this view supports grouping via the groupDescriptions property.
canSort
Gets a value that indicates whether this view supports sorting via the sortDescriptions property.
currentItem
Gets the current item in the view.
currentPosition
Gets the ordinal position of the current item in the view.
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);
groupDescriptions
Gets a collection of GroupDescription objects that describe how the items in the collection are grouped in the view.
groups
Gets the top-level groups.
isEmpty
Gets a value that indicates whether this view contains no items.
isPageChanging
Gets a value that indicates whether the index is changing.
itemCount
Gets the number of items in the view taking paging into account.
To get the total number of items, use the totalItemCount property.
Notice that this is different from the .NET IPagedCollectionView, where itemCount and totalItemCount both return the count before paging is applied.
items
Gets the filtered, sorted, grouped items in the view.
pageIndex
Gets the zero-based index of the current page.
pageSize
Gets or sets the number of items to display on each page.
sortDescriptions
Gets a collection of SortDescription objects that describe how the items in the collection are sorted in the view.
sourceCollection
Gets or sets the collection object from which to create this view.
totalItemCount
Gets the total number of items in the view before paging is applied.
To get the number of items in the current view taking paging into account, use the itemCount property.
Notice that this is different from the .NET IPagedCollectionView, where itemCount and totalItemCount both return the count before paging is applied.
Methods
beginUpdate
-
Suspends refreshes until the next call to endUpdate.
Returns void
contains
-
Returns a value that indicates whether a given item belongs to this view.
Parameters
-
item: T
The item to locate in the collection.
Returns boolean
-
deferUpdate
-
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.
-
Optional force: boolean
Whether to force a refresh when ending the update.
Returns void
-
endUpdate
-
Resumes refreshes suspended by a call to beginUpdate.
Parameters
-
Optional force: boolean
Whether to force a refresh when ending the update.
Returns void
-
implementsInterface
-
Returns true if the object implements a given interface.
Parameters
-
interfaceName: string
Name of the interface to look for.
Returns boolean
-
moveCurrentTo
-
Sets the specified item to be the current item in the view.
Parameters
-
item: T
The item to set as the currentItem.
Returns boolean
-
moveCurrentToFirst
-
Sets the first item in the view as the current item.
Returns boolean
moveCurrentToLast
-
Sets the last item in the view as the current item.
Returns boolean
moveCurrentToNext
-
Sets the item after the current item in the view as the current item.
Returns boolean
moveCurrentToPosition
-
Sets the item at the specified index in the view as the current item.
Parameters
-
index: number
The index of the item to set as the currentItem.
Returns boolean
-
moveCurrentToPrevious
-
Sets the item before the current item in the view as the current item.
Returns boolean
moveToFirstPage
-
Sets the first page as the current page.
Returns boolean
moveToLastPage
-
Sets the last page as the current page.
Returns boolean
moveToNextPage
-
Moves to the page after the current page.
Returns boolean
moveToPage
-
Moves to the page at the specified index.
Parameters
-
index: number
Index of the page to move to.
Returns boolean
-
moveToPreviousPage
-
Moves to the page before the current page.
Returns boolean
refresh
-
Re-creates the view using the current sort, filter, and group parameters.
Returns void
Events
collectionChanged
Occurs when the collection changes.
currentChanged
Occurs after the current item changes.
currentChanging
Occurs before the current item changes.
pageChanged
Occurs after the page index changes.
pageChanging
Occurs before the page index changes.
Defines methods and properties that extend ICollectionView to provide paging capabilities.