Fields
-
<static> PivotType :string
-
Valid pivot types
- Source:
Properties:
Name Type Default Description BEFORE
string before Move the from location before the to location AFTER
string after Move the from location after the to location SWAP
string swap Exchange the from location with the to location
Methods
-
getAxes() → {Array}
-
Get the oj.CubeAxis objects in this cube
- Source:
Returns:
an array of oj.CubeAxis objects- Type
- Array
-
getLayout() → {Array}
-
Return the current layout used to build the cube
- Source:
- See:
Returns:
current layout- Type
- Array
-
getValues(indices) → {Array|Object}
-
Get oj.CubeDataValues from this cube. These represent the values of the data in the "body" of the cube
Parameters:
Name Type Description indices
Array an axis-ordered array of Objects or numbers. If Objects, each should contain a 'start' property (the zero based start index for the axis) and a 'count' representing the number of data values beginning at 'start' to return on this axis. This format allows the retrieval of a block of data. Passing an array of numbers alone is equivalent to passing {start: , count:1} and getting a single oj.CubeDataValue - Source:
Returns:
either an array of arrays of oj.CubeDataValue, depending on the number of values requested in indices, or a single oj.CubeDataValue The first subscript represents the 0th axis' values, and so on.- Type
- Array | Object
-
pivot(axisFrom, levelFrom, axisTo, levelTo, type) → {boolean}
-
Parameters:
Name Type Description axisFrom
number the axis from which to move a level levelFrom
number the level within axisFrom to move to axisTo/levelTo (zero is slowest/outermost) axisTo
number the axis to which to move levelFrom levelTo
number the level within axisTo to move the levelFrom level (zero is slowest/outermost) type
oj.Cube.PivotType the type of pivot to perform - Source:
Returns:
true if successful- Type
- boolean
-
setPage(pin)
-
Set a pinned index for all axes above axis 1 ("pages")
Parameters:
Name Type Description pin
Array an array of objects containing an integer 'axis' attribute and its corresponding 'index' value (to which to pin the cube) - Source: