GetHyperCubePivotData method

Overview

Retrieves the values of a pivot table. It is possible to retrieve specific pages of data.

Name	Description	Type
qPath	Path to the definition of the object to be selected. For example, /qHyperCubeDef. This parameter is mandatory.	String
qPages	Array of pages to retrieve This parameter is mandatory.	Array of NxPage

Name

Description

Type

qPath

Path to the definition of the object to be selected.

For example, /qHyperCubeDef.

This parameter is mandatory.

String

qPages

Array of pages to retrieve

This parameter is mandatory.

Array of NxPage

Name	Description	Type
qLeft	Position from the left. Corresponds to the first column.	Integer
qTop	Position from the top. Corresponds to the first row.	Integer
qWidth	Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef).	Integer
qHeight	Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef).	Integer

A data set is returned.

Name	Description	Type
qDataPages	A data set	Array of NxPivotPage

Name	Description	Type
qLeft	Information about the left dimension values of a pivot table.	Array of NxPivotDimensionCell
qTop	Information about the top dimension values of a pivot table. If there is no top dimension in the pivot table, information about the measures are given.	Array of NxPivotDimensionCell
qData	Array of data.	Array of ArrayOfNxValuePoint
qArea	Size and offset of the data in the matrix.	Rect

Name	Description	Type
qText	Some text	String
qElemNo	Rank number of the value If set to -1, it means that the value is not an element number.	Integer
qValue	Value of the cell Is set to NaN, if the value is not a number.	Double precision floating point
qCanExpand	If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.	Boolean
qCanCollapse	If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.	Boolean
qType	Type of the cell	One of: V for NX_DIM_CELL_VALUE. Applies to values in the data matrix. E for NX_DIM_CELL_EMPTY. Applies to empty cells in the top and left dimensions. N for NX_DIM_CELL_NORMAL. Applies to left and top dimensions cells. T for NX_DIM_CELL_TOTAL. Applies to cells marked with Total P for NX_DIM_CELL_PSEUDO. Applies to pseudo dimensions. R for NX_DIM_CELL_ROOT. Applies to root node. U for NX_DIM_CELL_NULL. Applies to Null values in the data matrix.
qUp	Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight.	Integer
qDown	Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight.	Integer
qSubNodes	Information about sub nodes (or sub cells) The array is empty [ ] when there is no sub nodes.	Array of NxPivotDimensionCell

Name	Description	Type
qArrayOfNxValuePoint	Array of data	Array of NxPivotValuePoint

Name	Description	Type
qLabel	Label of the cell. This parameter is optional.	String
qText	Some text related to the cell.	String
qNum	Value of the cell.	Double precision floating point
qType	Type of the cell.	One of: V for NX_DIM_CELL_VALUE. Applies to values in the data matrix. E for NX_DIM_CELL_EMPTY. Applies to empty cells in the top and left dimensions. N for NX_DIM_CELL_NORMAL. Applies to left and top dimensions cells. T for NX_DIM_CELL_TOTAL. Applies to cells marked with Total P for NX_DIM_CELL_PSEUDO. Applies to pseudo dimensions. R for NX_DIM_CELL_ROOT. Applies to root node. U for NX_DIM_CELL_NULL. Applies to Null values in the data matrix.
qAttrExps	Attribute expressions values.	Null or NxAttributeExpressionValues

Name	Description	Type
qValues	List of attribute expressions values.	Array of NxSimpleValue

Name	Description	Type
qText	Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.	String
qNum	Numeric value of the attribute expression. This property is set to NaN (Not a Number) if the attribute expression value is not a numeric. Numerical values are not returned as text.	Double precision floating point

Name

Description

Type

qText

Text related to the attribute expression value.

This property is optional. No text is returned if the attribute expression value is a numeric.

String

qNum

Numeric value of the attribute expression.

This property is set to NaN (Not a Number) if the attribute expression value is not a numeric.

Numerical values are not returned as text.

Double precision floating point

Name	Description	Type
qLeft	Position from the left. Corresponds to the first column.	Integer
qTop	Position from the top. Corresponds to the first row.	Integer
qWidth	Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef).	Integer
qHeight	Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef).	Integer

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!