Class: ArrayHeaderSet

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

E54107-01

QuickNav

oj. ArrayHeaderSet

Constructor

new ArrayHeaderSet(start, end, axis, callback)

A HeaderSet represents a collection of headers. The HeaderSet is an object returned by the success callback of the fetchHeaders method on DataGridDataSource. This implementation of HeaderSet is used by the array DataGridDataSource.
Parameters:
Name Type Description
start number the start index of the header set.
end number the end index of the header set.
axis string the axis of the header, value is either 'row' or 'column'.
callback Object the callback to invoke on to retrieve data and metadata.
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

getStart() → {number}

Gets the start index of the result set.
Source:
Returns:
the start index of the result set.
Type
number