Class: CubeAxis

Oracle® JavaScript Extension Toolkit (JET)
15.0.0
F75901-01

Since:
  • 1.1.0
Module:
  • ojcube

QuickNav

Fields

Methods

Description

Represents an axis (a collection of levels) in a cube. There is a set of CubeAxisValues at each index within an axis, up to one per CubeLevel on the axis


Usage

For additional information visit:


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.<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 CubeLevel

Type
Array.<CubeLevel>

getValues(index) : {Array.<CubeAxisValue>}

Get the CubeAxisValue objects at the given index, one for each level represented at this index within the axis. Note that the number of CubeAxisValues returned may not match the overall CubeLevel count on the axis
Parameters:
Name Type Description
index number index for which to get the CubeAxisValues
Returns:

the ordered list of CubeAxisValues at this index (slowest to fastest varying).

Type
Array.<CubeAxisValue>