Type Alias TreeDataDef

Defines the properties of a TreeData object. For more information about the definition of a TreeData object, see Generic object.

Stability: stable

type TreeDataDef = {
    qCalcCondition?: NxCalcCond;
    qContextSetExpression?: string;
    qDimensions?: NxTreeDimensionDef[];
    qExpansionState?: ExpansionData[];
    qInitialDataFetch?: NxTreeDataOption[];
    qInterColumnSortOrder?: number[];
    qOpenFullyExpanded?: boolean;
    qPopulateMissing?: boolean;
    qStateName?: string;
    qSuppressMissing?: boolean;
    qSuppressZero?: boolean;
    qTitle?: StringExpr;
    qValueExprs?: NxMeasure[];
}
Index

Properties

qCalcCondition? qContextSetExpression? qDimensions? qExpansionState? qInitialDataFetch? qInterColumnSortOrder? qOpenFullyExpanded? qPopulateMissing? qStateName? qSuppressMissing? qSuppressZero? qTitle? qValueExprs?

Properties

qCalcCondition?: NxCalcCond

Specifies a calculation condition object. If CalcCondition.Cond is not fulfilled, the TreeData is excluded from the calculation and CalcCondition.Msg is evaluated. By default, there is no calculation condition. This property is optional.

qContextSetExpression?: string

Set Expression valid for the whole cube. Used to limit computations to the set specified.

qDimensions?: NxTreeDimensionDef[]

Array of dimensions.

qExpansionState?: ExpansionData[]

Expansion state per dimension.

Stability: experimental

qInitialDataFetch?: NxTreeDataOption[]

Initial data set. This property is optional.

qInterColumnSortOrder?: number[]

Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.

qOpenFullyExpanded?: boolean

If this property is set to true, the cells are opened expanded. The default value is false.

qPopulateMissing?: boolean

If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

qStateName?: string

Name of the alternate state. Default is current selections $ .

qSuppressMissing?: boolean

Removes missing values.

qSuppressZero?: boolean

Removes zero values.

qTitle?: StringExpr

Title of the TreeData object, for example the title of a chart.

qValueExprs?: NxMeasure[]

List of measures to calculate on the whole tree.

Settings

Member Visibility

On This Page

Properties