Class: Cube

Oracle® JavaScript Extension Toolkit (JET)
7.1.0

F18183-01

QuickNav

Fields


Cube

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.Cube 
})

Description

Functions implemented by oj.DataColumnCube and oj.DataValueAttributeCube

Fields

(static) PivotType :string

Valid pivot types
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.<oj.CubeAxis>}

Get the oj.CubeAxis objects in this cube
Returns:
an array of oj.CubeAxis objects
Type
Array.<oj.CubeAxis>

getLayout() → {Array.<Object>}

Return the current layout used to build the cube
See:
Returns:
current layout
Type
Array.<Object>

getValues(indices) → {Array.<oj.CubeDataValue>|oj.CubeDataValue}

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<Cube.Indices | number> 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
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.<oj.CubeDataValue> | oj.CubeDataValue

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
Returns:
true if successful
Type
boolean

setPage(pin) → {undefined}

Set a pinned index for all axes above axis 1 ("pages")
Parameters:
Name Type Description
pin Array.<oj.Cube.Pin> | oj.Cube.Pin an array of objects (or a single object) containing an integer 'axis' attribute and its corresponding 'index' value (to which to pin the cube)
Returns:
Type
undefined

Type Definitions

Indices

Object in getValues indices parameter
Properties:
Name Type
start number
count number

Pin

Object in setPage pin parameter
Properties:
Name Type
axis number
index number