Constructor
new PagingDataGridDataSource(dataSource, options)
Parameters:
Name | Type | Description |
---|---|---|
dataSource |
oj.DataGridDataSource | null | |
options |
Object | null | Array of options for the PagingControlDataSource |
Methods
-
#fetch(options) → {Promise}
-
Calls fetch on the datasource with paging options.
Parameters:
Name Type Argument Description options
Object <optional>
Options to control fetch Properties
Name Type Description startIndex
number The index at which to start fetching records. silent
boolean If set, do not fire a sync event. - Source:
Returns:
Promise object resolves when done- Type
- Promise
-
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. -
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. -
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:
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:
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:
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
-
getEndItemIndex() → {number}
-
Get the current page end index
- Source:
Returns:
The current page end index- Type
- number
-
getPage() → {number}
-
Get the current page
- Source:
Returns:
The current page- Type
- number
-
getPageCount() → {number}
-
Get the page count
- Source:
Returns:
The total number of pages- Type
- number
-
getStartItemIndex() → {number}
-
Get the current page start index
- Source:
Returns:
The current page start index- Type
- number
-
handleEvent(eventType, event) → {boolean}
-
Handle the event
Parameters:
Name Type Description eventType
string event type event
Object event - Inherited From:
- Source:
Returns:
Returns false if event is cancelled- 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:
Returns:
indexes an object containing the index for each axis- Type
- Object.<number, number>
-
Init()
-
Initializes the instance.
-
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:
Returns:
an object containing the keys for each axis- Type
- Object.<Object, Object>
-
move(moveKey, atKey, position, callbackObjects)
-
Move a model to a new index in the collection, if atKey is null adds to the end
Parameters:
Name Type Argument Description moveKey
Object the key of the model that should be moved atKey
Object the key of the model that the moved model should be inserted before or after position
string The position of the moved row relative to the reference row. Valid values are: "before", "after" callbacks.success
function() the callback to invoke when the move completed successfully. callbacks.error
function({status: Object}) the callback to invoke when move 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. -
moveOK(rowToMove, referenceRow, position) → {string}
-
Checks whether a move operation is valid.
Parameters:
Name Type Description rowToMove
Object the key of the row to move referenceRow
Object the key of the reference row which combined with position are used to determine the destination of where the row should moved to. position
string The position of the moved row relative to the reference row. Valid values are: "before", "after". - Source:
Returns:
returns "valid" if the move is valid, "invalid" otherwise.- Type
- string
-
off(eventType, eventHandler)
-
Detach an event handler
Parameters:
Name Type Description eventType
string eventType eventHandler
function(Object) event handler function - Inherited From:
- Source:
-
on(eventType, eventHandler)
-
Attach an event handler
Parameters:
Name Type Description eventType
string eventType eventHandler
function(Object) event handler function - Inherited From:
- Source:
-
setPage(value, options)
-
Set the current page
Parameters:
Name Type Argument Description value
number The current page options
Object <optional>
Options pageSize: The page size.
-
#size() → {number}
-
- Source:
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. -
#totalSize() → {number}
-
- Source:
Returns:
total size of data- Type
- number
-
#totalSizeConfidence() → {string}
-
Returns the confidence for the totalSize value.
- Source:
Returns:
"actual" if the totalSize is the time of the fetch is an exact number "estimate" if the totalSize is an estimate "atLeast" if the totalSize is at least a certain number "unknown" if the totalSize is unknown- Type
- string