Class: CubeAxis

Oracle® JavaScript Extension Toolkit (JET)
5.0.0

E90577-01

QuickNav

Fields

CubeAxis

Version:
  • 5.0.0
Since:
  • 1.1.0
Module:
  • ojcube
Represents an axis (a collection of levels) in a cube. There is a set of oj.CubeAxisValues at each index within an axis, up to one per oj.CubeLevel on the axis
Parameters:
Name Type Description
levels Array.<Object> array of levels, slowest to fastest, to put in this axis
axis number the number of this axis
cube oj.Cube the cube on which to generate levels

Fields

axis :number

This axis' number

Methods

getExtent() → {number}

Gets the total number of indices (data value locations) along this axis
Returns:
the total number of indices along the axis
Type
number

getIndex(key) → {number}

Return the index of the given key within the axis. Return -1 if not found.
Parameters:
Name Type Description
key string
Returns:
index of value found using key, -1 if not found
Type
number

getLevels() → {Array.<oj.CubeLevel>}

Gets an ordered list (slowest to fastest varying) of all the levels represented within the axis. Some indices along the axis may not be represented by every level
Returns:
an ordered array of oj.CubeLevel
Type
Array.<oj.CubeLevel>

getValues(index) → {Array.<oj.CubeAxisValue>}

Get the oj.CubeAxisValue objects at the given index, one for each level represented at this index within the axis. Note that the number of oj.CubeAxisValues returned may not match the overall oj.CubeLevel count on the axis
Parameters:
Name Type Description
index number index for which to get the oj.CubeAxisValues
Returns:
the ordered list of oj.CubeAxisValues at this index (slowest to fastest varying).
Type
Array.<oj.CubeAxisValue>