Class: FlattenedTreeCellSet

Oracle® JavaScript Extension Toolkit (JET)
5.0.0

E90577-01

QuickNav

FlattenedTreeCellSet

Version:
  • 5.0.0
Since:
  • 1.0
Module:
  • ojflattenedtreedatagriddatasource
A CellSet represents a collection of cells. The CellSet is an object returned by the success callback of the fetchCells method on DataGridDataSource. The FlattenedTreeCellSet is a FlattenedDataGridDataSource specific implementation of methods on CellSet.

Constructor

new FlattenedTreeCellSet(startRow, endRow, startColumn, endColumn, nodeSet, columns)

Parameters:
Name Type Description
startRow number the start row index of the cell set
endRow number the end row index of the cell set
startColumn number the start column index of the cell set
endColumn number the end column index of the cell set
nodeSet Object the node set in which this cell set wraps around
columns Array | null the set of column keys
See:
  • oj.FlattenedDataGridDataSource

Methods

getCount(axis) → {number}

Gets the actual count of the result set for the specified axis.
Parameters:
Name Type Description
axis string the axis in which to inquire the actual count of the result set. Valid values are "row" and "column".
Returns:
the actual count of the result set for the specified axis.
Type
number

getData(indexes) → {Object}

Gets the data of the specified index. An error is throw when 1) the range is not yet available 2) the index specified is out of bounds.
Parameters:
Name Type Description
indexes Object the index of each axis in which we want to retrieve the data from.
Properties:
Name Type Description
indexes.row number the index of the row axis.
indexes.column number the index of the column axis.
Returns:
the data object for the specified index.
Type
Object

getExtent(indexes) → {Object}

Gets the extent of a particular row/column index within the context of the cellSet. Extent is defined as the number of indexes along the appropriate axis spanned by the cell. If the extent extends beyond the start and end of the requested cell range the extent should be trimmed to the edge of the requested cell range and the object for {'more': {'before', 'after'}} should have the value appropriate boolean set.
Parameters:
Name Type Description
indexes Object the index of each axis in which we want to retrieve the data from.
Properties:
Name Type Description
indexes.row number the index of the row axis.
indexes.column number the index of the column axis.
Since:
  • 4.0.0
Returns:
an object containing two properties row and column. Each of those properties has two sub properties: extent: the number of absolute indexes spanned by the cell at this index bounded by the edges of the result set for the specified axis. more: object with keys 'before'/'after' and boolean values true/false representing whether there are more indexes before/after what is available in the cellSet
Type
Object
Example

In this example the cell spans 5 row indexes and 2 column indexes and there are more column indexes spanned by the cell that aren't included in this cellSet:

{
 'row': {'extent':5, 'more': {'before':false, 'after':false}},
 'column': {'extent':2, 'more': {'before':false, 'after':true}}
}

getMetadata(indexes) → {Object}

Gets the metadata of the specified index. An error is throw when 1) the range is not yet available 2) the index specified is out of bounds.
Parameters:
Name Type Description
indexes Object the index of each axis in which we want to retrieve the metadata from.
Properties
Name Type Description
row number the index of the row axis.
column number the index of the column axis.
Returns:
the metadata object for the specific index. The metadata that the DataGrid supports are: 1) keys - the key (of each axis) of the cell.
Type
Object

getStart(axis) → {number}

Gets the start index of the result set for the specified axis.
Parameters:
Name Type Description
axis string the axis in which to inquire the actual count of the result set. Valid values are "row" and "column".
Returns:
the start of the index of the result set for the specified axis.
Type
number