Class: CubeHeaderSet

Oracle® JavaScript Extension Toolkit (JET)
7.1.0

F18183-01

QuickNav


CubeHeaderSet

Version:
  • 7.1.0
Since:
  • 1.1.0
Module:
  • ojcube

Module usage

See JET Module Loading for an overview of module usage within JET.

Javascript Import Format
define(['ojs/ojcube'], function(cube) {
 // Application should call API on cube.CubeHeaderSet 
})

Description

A HeaderSet represents a collection of headers. The HeaderSet is an object returned by the success callback of the fetchHeaders method on CubeDataGridDataSource.

Methods

getCount() → {number}

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

getData(index, level) → {any}

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. This is an absolute index across the entire axis
level number the level of the header
Returns:
the data object for the specific index.
Type
any

getDepth(index, level) → {number}

Gets the depth of an index starting at a particular level.
Parameters:
Name Type Description
index number the index of the header (absolute within the axis)
level number the level of the header
Returns:
- the number of levels of the result set for the specified axis.
Type
number

getExtent(index, level) → {Object}

Gets the extent of an index on a particular level. This is the extent such as it is within the defined header set, not across the entire axis. If the header falls across the beginning of the headerset or the end, then its extent should be only that part lying within the header set
Parameters:
Name Type Description
index number the index of the header (absolute within the axis)
level number the level of the header
Returns:
an object containing two values. example: {extent:5, more: {'before':false, 'after':true}} extent: the number of slices of the result set for the specified axis. more: object with keys 'before'/'after' and boolean values true/false representing whether there may be more rows/columns before or after the headerSet
Type
Object

getLabel(level) → {*}

Gets the label for the level along the axis of that header. Specify null to have no header labels.
Parameters:
Name Type Description
level number the header level to retrieve the label data for
Returns:
the data for the header label
Type
*

getLevelCount() → {number}

Gets the actual number of levels of the result set for the specified axis.
Returns:
the number of levels of the result set for the specified axis.
Type
number

getMetadata(index, level) → {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. This is an absolute index across the entire axis
level number the level of the header
Returns:
the metadata object for the specific index.
Type
Object

getStart() → {number}

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