Class: FlattenedTreeHeaderSet

Oracle® Fusion Middleware Oracle JavaScript Extension Toolkit (JET)
12c (12.1.4)

E54107-01

QuickNav

oj. FlattenedTreeHeaderSet

Constructor

new FlattenedTreeHeaderSet(start, end, headers, nodeSet, rowHeader)

A HeaderSet represents a collection of headers. The HeaderSet is an object returned by the success callback of the fetchHeaders method on DataGridDataSource. This is an OJ collection specific implementation of the HeaderSet.
Parameters:
Name Type Argument Description
start number the start index of header set.
end number the end index of the header set.
headers Array the array of headers. Required for column headers.
nodeSet Object <optional>
the node set containing data about the row header. Required for row headers.
rowHeader string <optional>
the id of the row header column. Required for row headers.
Source:

Methods

getCount() → {number}

Gets the actual count of the result set.
Source:
Returns:
the actual count of the result set.
Type
number

getData(index) → {Object}

Gets the data of the specified index. An error is throw when 1) the range is not yet available and 2) the index specified is out of bounds.
Parameters:
Name Type Description
index number the index of the header in which we want to retrieve the header from.
Source:
Returns:
the data object for the specific index.
Type
Object

getMetadata(index) → {Object}

Gets the metadata of the specified index. An error is throw when 1) the range is not yet available and 2) the index specified is out of bounds. The metadata that the data source can optionally return are: 1) sortDirection - the initial sort direction of the header. Valid values are "ascending" and "descending". 2) key - the key of the row/column header.
Parameters:
Name Type Description
index number the index of the header in which we want to retrieve the metadata from.
Source:
Returns:
the metadata object for the specific index.
Type
Object