Dataset
A dataset connects page elements to a set of items in a data collection.
Perform actions on an object
- add( )
Adds a new blank item.
- getCurrentItem( )
Returns the current item.
- getCurrentItemIndex( )
Returns the current item's index.
- getCurrentPageIndex( )
Gets the index of the dataset's current page.
- getItems( )
Returns the selected items.
- getPageSize( )
Gets the dataset's page size.
- getTotalCount( )
Returns the number of items in the dataset that match its filter criteria.
- getTotalPageCount( )
Gets the number of pages in the dataset.
- hasNext( )
Indicates if there is a next item.
- hasNextPage( )
Indicates if there is a next page of data.
- hasPrevious( )
Indicates if there is a previous item.
- hasPreviousPage( )
Indicates if there is a previous page of data.
- loadMore( )
Loads the next page of data in addition to the current data.
- loadPage( )
Loads the specified page.
- new( )
Deprecated. This function will continue to work, but a newer version is available. Use the add() function instead.
- next( )
Saves the current item and moves to the next item.
- nextPage( )
Moves to the next page of data.
- onAfterSave( )
Adds an event handler that runs just after a save.
- onBeforeSave( )
Adds an event handler that runs just before a save.
- onCurrentIndexChanged( )
Adds an event handler that runs when the current index changes.
- onError( )
Adds an event handler that runs when an error occurs.
- onItemValuesChanged( )
Adds an event handler that runs when a value of the current item changes.
- onReady( )
Adds an event handler that runs when the dataset is ready.
- onReadyAsync( )
The onReadyAsync() function returns a Promise that resolves when a dataset is ready.
- previous( )
Saves the current item and moves to the previous item.
- previousPage( )
Moves to the previous page of data.
- refresh( )
Refetches the contents of the dataset from the collection.
- remove( )
Removes the current item.
- revert( )
Reverts the current item to its saved value.
- save( )
Saves the current item.
- setCurrentItemIndex( )
Sets the current item by index.
- setFieldValue( )
Updates the value of a field in the current item.
- setFieldValues( )
Updates the values of a set of fields in the current item.
- setFilter( )
Sets the dataset filter.
- setPageSize( )
Sets the dataset's page size.
- setSort( )
Sets the dataset sort order.