- See:
Methods
-
getChildren() → {Array.<oj.CubeAxisValue>}
-
Get an ordered list of the child oj.CubeAxisValues of this value, at the next level
Returns:
an array of the children of this oj.CubeAxisValue- Type
- Array.<oj.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}
PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.
-
Get the label for this axis header location, if any. If none, falls back to getValue
- Since:
- 1.1.0
Returns:
the label for this axis header value- Type
- string | null
-
getLevel() → {oj.CubeLevel}
-
Get the oj.CubeLevel of which this value is a member
Returns:
the level to which this header value belongs- Type
- oj.CubeLevel
-
getParents() → {Array.<oj.CubeAxisValue>}
-
Get the parent oj.CubeAxisValues of this value
Returns:
an array of oj.CubeAxisValues--all the slower-varying level axis values under which this value is grouped- Type
- Array.<oj.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