Class: CubeDataValue

Oracle® JavaScript Extension Toolkit (JET)
7.1.0

F18183-01

QuickNav


CubeDataValue

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

Description

Objects returned by oj.Cube.getValues() and representing a single cell within the cube's data body. Note that more functions or properties can be added to this object in the future as required

Methods

getAggregation() → {string|undefined}

Get the aggregation type used to create this data value, if any
Returns:
the aggregation type used for this data value
Type
string | undefined

getIndices() → {Array.<number>}

Get the indices in axis order of the location of this data cell within the cube data body
Returns:
an array of numeric indices in axis order
Type
Array.<number>

getRows() → {Array.<Object>|null|undefined}

Get the attribute/value pairs of the rows that were aggregated to create this data value. The result may be a single row's set of attribute/value pairs if no aggregation took place
Returns:
the array of attribute/value pairs representing rows aggregated to create this data value
Type
Array.<Object> | null | undefined

getValue() → {Object|null|number|string}

Get the actual data value in this cell
Returns:
the data value
Type
Object | null | number | string