Class: FlattenedTreeCellSet

Oracle® JavaScript Extension Toolkit (JET)
3.2.0

E87541-01

QuickNav

oj. FlattenedTreeCellSet

Version:
  • 3.2.0

Constructor

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

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.
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
Source:

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".
Source:
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
row number the index of the row axis.
column number the index of the column axis.
Source:
Returns:
the data object for the specified index.
Type
Object

#getMetadata(indexes)

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.
Source:
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.

#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".
Source:
Returns:
the start of the index of the result set for the specified axis.
Type
number