Type Alias NxTreeNode

Represents a dimension in the tree.

Stability: stable

type NxTreeNode = {
    qAttrDims?: NxAttributeDimValues;
    qAttrExps?: NxAttributeExpressionValues;
    qCanCollapse?: boolean;
    qCanExpand?: boolean;
    qElemNo?: number;
    qGroupPos?: number;
    qGroupSize?: number;
    qMaxPos?: number[];
    qMinNeg?: number[];
    qNodes?: NxTreeNode[];
    qRow?: number;
    qState?: StateEnumType;
    qText?: string;
    qTreePath?: number[];
    qType?: NxDimCellType;
    qValue?: number;
    qValues?: NxTreeValue[];
}
Index

Properties

Attribute dimension values.

Attribute expression values.

qCanCollapse?: boolean

If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

qCanExpand?: boolean

If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

qElemNo?: number

Element number.

qGroupPos?: number

The position of this node inside it's group in the complete tree, i.e. Not dependant om what part is fetched.

qGroupSize?: number

Nbr of nodes connected to this node on the next level of the tree. Not dependant on what part is fetched.

qMaxPos?: number[]

Total of the positive values in the current group of cells.

qMinNeg?: number[]

Total of the negative values in the current group of cells.

qNodes?: NxTreeNode[]

The children of this node in the fetched tree structure.

qRow?: number

Row index in the data matrix. The indexing starts from 0.

qState?: StateEnumType

Selection State of the value. The default state for a measure is L(Locked).

One of:

  • L or LOCKED
  • S or SELECTED
  • O or OPTION
  • D or DESELECTED
  • A or ALTERNATIVE
  • X or EXCLUDED
  • XS or EXCL_SELECTED
  • XL or EXCL_LOCKED
  • NSTATES
qText?: string

The text version of the value, if available.

qTreePath?: number[]

The GroupPos of all prior nodes connected to this one, one position for each level of the tree. If this node is attached directly to the root, this array is empty.

Type of the cell.

One of:

  • V or NX_DIM_CELL_VALUE
  • E or NX_DIM_CELL_EMPTY
  • N or NX_DIM_CELL_NORMAL
  • T or NX_DIM_CELL_TOTAL
  • O or NX_DIM_CELL_OTHER
  • A or NX_DIM_CELL_AGGR
  • P or NX_DIM_CELL_PSEUDO
  • R or NX_DIM_CELL_ROOT
  • U or NX_DIM_CELL_NULL
  • G or NX_DIM_CELL_GENERATED
qValue?: number

Value of the cell. Is set to NaN , if the value is not a number.

qValues?: NxTreeValue[]

The measures for this node.