Class: CubeAxisValue

Oracle® JavaScript Extension Toolkit (JET)
12.1.0
F52696-01

Since:
  • 1.1.0
Module:
  • ojcube

QuickNav

Methods

Description

Represents one value within an axis header


Usage

For additional information visit:


See:
See:

Methods

getChildren : {Array.<CubeAxisValue>}

Get an ordered list of the child CubeAxisValues of this value, at the next level
Returns:
an array of the children of this CubeAxisValue
Type
Array.<CubeAxisValue>

getDepth : {number}

Get the number of levels this header value spans
Returns:
the number of levels this header value spans. Typically one, but in the future something like a grand total may span all the available levels at a particular axis value location
Type
number

getExtent : {number}

Get the number of indices spanned by this value
Returns:
the number of indices spanned by this value
Type
number

getLabel : {string|null}

Get the label for this axis header location, if any. If none, falls back to CubeAxisValue#getValue
Since:
  • 1.1.0
Returns:
the label for this axis header value
Type
string | null

getLevel : {CubeLevel}

Get the CubeLevel of which this value is a member
Returns:
the level to which this header value belongs
Type
CubeLevel

getParents : {Array.<CubeAxisValue>}

Get the parent CubeAxisValues of this value
Returns:
an array of CubeAxisValues--all the slower-varying level axis values under which this value is grouped
Type
Array.<CubeAxisValue>

getStart : {number}

Get the starting index of this value within the axis
Returns:
the starting index of this value within the axis
Type
number

getValue : {Object|string}

Get the actual value of this axis header location
Returns:
the value at this location in the header
Type
Object | string