Constructor
new FlattenedTreeDataGridDataSource(treeDataSource, options)
The DataGrid specific implementation of the FlattenedTreeDataSource class.
Parameters:
Name | Type | Argument | Description |
---|---|---|---|
treeDataSource |
Object | the instance of TreeDataSource to flattened | |
options |
Object |
<optional> |
the options set on this data source. See documentation for a list of supported options. |
- Source:
Methods
-
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(oj.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:
-
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(oj.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:
-
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", "row", "column". 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.
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:
"exact" 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 "exact".- Type
- string
-
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. Return null if the indexes cannot be found.- Type
- Object.<number, number>
-
Init()
-
Initializes the data source.
- 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:
Returns:
an object containing the keys for each axis- Type
- Object.<Object, Object>
-
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:
Non-public Methods
-
<protected> handleMaxCountReached(range)
-
Handles the case when the maximum number of rows have been reached
Parameters:
Name Type Description range
Object the range of the fetch request that cause the max count to be reached Properties
Name Type Description start
number the start index of the range count
number the count of the range - Source:
-
<protected> insertMetadata(key, metadata)
-
A hook for FlattenedTreeDataSource to inject additional metadata into the NodeSet
Parameters:
Name Type Description key
Object the row key identifying the row metadata
Object the existing metadata to inject into - Source:
-
<protected> insertRows(insertAtIndex, insertAtRowKey, nodeSet)
-
Implementation of abstract method to insert a set of rows into the DataGrid
Parameters:
Name Type Description insertAtIndex
number the flattened index of the node where the rows are inserted. insertAtRowKey
Object the key of the node where the rows are inserted (the parent key) nodeSet
Object the node set containing data/metadata of inserted rows - Source:
-
<protected> removeRows(rowKeys)
-
Implementation of bstract method to remove the specified rows in the DataGrid
Parameters:
Name Type Description rowKeys
Array.<Object> an array of keys of the rows to be remove. - Source: