Constructor
new PagingDataGridDataSource(dataSource, options)
Parameters:
Name | Type | Description |
---|---|---|
dataSource |
oj.DataGridDataSource | null | |
options |
Object | null | Array of options for the PagingControlDataSource |
- Source:
Methods
-
#fetch(options)
-
Calls fetch on the datasource with paging options.
Parameters:
Name Type Argument Description options
Object <optional>
Options to control fetch startIndex: The index at which to start fetching records.
pageSize: The number of records to be fetched.
- Inherited From:
- Source:
- ojpagingcontrol/PagingDataSource.js, line 40
Throws:
- Type
- Error
-
fetchCells(cellRanges, callbacks, callbackObjects)
-
Fetch a range of cells from the data source.
Parameters:
Name Type Argument Description cellRanges
Array.<Object> Information about the cell range. A cell range is defined by an array of range info for each axis, where each range contains three properties: axis, start, count. Properties
Name Type Description axis
string the axis associated with this range where cells are fetched. Valid values are "row" and "column". start
number the start index of the range for this axis in which the cells are fetched. count
number the size of the range for this axis in which the cells are fetched. callbacks
Object the callbacks to be invoke when fetch cells operation is completed. The valid callback types are "success" and "error". Properties
Name Type Description success
function(CellSet) the callback to invoke when fetch cells completed successfully. error
function({status: Object}) the callback to invoke when fetch cells failed. callbackObjects
Object <optional>
the object in which the callback function is invoked on. This is optional. You can specify the callback object for each callbacks using the "success" and "error" keys. - Source:
- ojdatagrid/PagingDataGridDataSource.js, line 194
-
fetchHeaders(headerRange, callbacks, callbackObjects)
-
Fetch a range of headers from the data source.
Parameters:
Name Type Argument Description headerRange
Object information about the header range, it must contain the following properties: axis, start, count. Properties
Name Type Description axis
string the axis of the header that are fetched. Valid values are "row" and "column". start
number the start index of the range in which the header data are fetched. count
number the size of the range in which the header data are fetched. callbacks
Object the callbacks to be invoke when fetch headers operation is completed. The valid callback types are "success" and "error". Properties
Name Type Description success
function(HeaderSet) the callback to invoke when fetch headers completed successfully. error
function({status: Object}) the callback to invoke when fetch cells failed. callbackObjects
Object <optional>
the object in which the callback function is invoked on. This is optional. You can specify the callback object for each callbacks using the "success" and "error" keys. - Source:
- ojdatagrid/PagingDataGridDataSource.js, line 173
-
getCapability(feature) → {string|null}
-
Determines whether this DataGridDataSource supports certain feature.
Parameters:
Name Type Description feature
string the feature in which its capabilities is inquired. Currently the only valid feature is "sort". - Source:
- ojdatagrid/PagingDataGridDataSource.js, line 256
Returns:
the name of the feature. For sort, the valid return values are: "full", "none". Returns null if the feature is not recognized.- Type
- string | null
-
getCount(axis) → {number}
-
Returns the total number of rows or columns. If the value return is not >= 0 then it is automatically assumed that the total count is unknown. In the case of paging returns the total number of rows/colums on the page.
Parameters:
Name Type Description axis
string the axis in which we inquire for the total count. Valid values are "row" and "column". - Source:
- ojdatagrid/PagingDataGridDataSource.js, line 140
Returns:
the total number of rows/columns.- Type
- number
-
getCountPrecision(axis) → {string}
-
Returns whether the total count returned in getCount function is an actual or an estimate.
Parameters:
Name Type Description axis
string the axis in which we inquire whether the total count is an estimate. Valid values are "row" and "column". - Source:
- ojdatagrid/PagingDataGridDataSource.js, line 153
Returns:
"actual" if the count returned in getCount function is the actual count, "estimate" if the count returned in getCount function is an estimate. The default value is "actual".- Type
- string
-
#hasMore() → {boolean}
-
- Inherited From:
- Source:
- ojpagingcontrol/PagingDataSource.js, line 53
Returns:
whether there is more data- Type
- boolean
-
indexes(keys) → {Object.<number, number>}
-
Returns the row and column index based on the keys.
Parameters:
Name Type Description keys
Object the key for each axis Properties
Name Type Description row
Object the key for the row axis column
Object the key for the column axis - Source:
- ojdatagrid/PagingDataGridDataSource.js, line 220
Returns:
indexes an object containing the index for each axis- Type
- Object.<number, number>
-
Init()
-
Initializes the instance.
- Source:
-
keys(indexes) → {Object.<Object, Object>}
-
Returns the keys based on the indexes.
Parameters:
Name Type Description indexes
Object the index for each axis Properties
Name Type Description row
Object the index for the row axis column
Object the index for the column axis - Source:
- ojdatagrid/PagingDataGridDataSource.js, line 207
Returns:
an object containing the keys for each axis- Type
- Object.<Object, Object>
-
#next()
-
Calls fetch for the next page of data. No-op if no more data.
- Inherited From:
- Source:
- ojpagingcontrol/PagingDataSource.js, line 67
Throws:
- Type
- Error
-
off(eventType, eventHandler)
-
Detach an event handler from the datasource
Parameters:
Name Type Description eventType
string eventType supported by the datasource eventHandler
function(Object) event handler function - Source:
- ojdatagrid/PagingDataGridDataSource.js, line 243
-
on(eventType, eventHandler)
-
Attach an event handler to the datasource
Parameters:
Name Type Description eventType
string eventType supported by the datasource eventHandler
function(Object) event handler function - Source:
- ojdatagrid/PagingDataGridDataSource.js, line 231
-
#previous()
-
Calls fetch for the previous page of data. No-op if at the beginning.
- Inherited From:
- Source:
- ojpagingcontrol/PagingDataSource.js, line 80
Throws:
- Type
- Error
-
setPageSize(n)
-
Set or change the number of models in a page
Parameters:
Name Type Description n
number page size - Source:
- ojdatagrid/PagingDataGridDataSource.js, line 112
-
#size() → {number}
-
- Source:
- ojdatagrid/PagingDataGridDataSource.js, line 274
Returns:
size of data- Type
- number
-
sort(criteria, callbacks, callbackObjects)
-
Performs a sort on the data source.
Parameters:
Name Type Argument Description criteria
Object the sort criteria. Properties
Name Type Description axis
string The axis in which the sort is performed, valid values are "row", "column" key
Object The key that identifies which header to sort direction
string the sort direction, valid values are "ascending", "descending", "none" (default) callbacks
Object the callbacks to be invoke upon completion of the sort operation. The callback properties are "success" and "error". Properties
Name Type Description success
function() the callback to invoke when the sort completed successfully. error
function({status: Object}) the callback to invoke when sort failed. callbackObjects
Object <optional>
the object in which the callback function is invoked on. This is optional. You can specify the callback object for each callbacks using the "success" and "error" properties. - Source:
- ojdatagrid/PagingDataGridDataSource.js, line 293
-
#startIndex() → {number}
-
- Inherited From:
- Source:
- ojpagingcontrol/PagingDataSource.js, line 103
Returns:
start index- Type
- number
-
#totalSize() → {number}
-
- Source:
- ojdatagrid/PagingDataGridDataSource.js, line 306
Returns:
total size of data- Type
- number