IPivotHeader.StairsHierarchy

Syntax

StairsHierarchy: Boolean;

Description

The StairsHierarchy property determines whether stairs hierarchy is used.

Comments

Available values:

True. Stairs hierarchy is used.
False. Default value. Stairs hierarchy is not used.

It is reasonable to use this property if several dimensions or levels of one dimension are located by rows or columns.

If the property is set to True, the IPivotDimensionLevelPropertiesCommon.ChildrenBeforeParents property is not considered.

To get whether table header element is a hierarchy stair, use the IPivotTableHeader.IsStairElement property.

Example

Executing the example requires that the repository contains an express report with the EXPRESS identifier. At least two dimensions should be present by rows in the report sidehead.

Add links to the Dimensions, Express, Metabase, Pivot system assemblies.

Sub UserProc;
Var
    MB: IMetabase;
    Express: IEaxAnalyzer;
    Pivot: IPivot;
    LeftHeader: IPivotHeader;
    TableHeader: IPivotTableHeader;
    Dim: IPivotDimension;
    i, Count: Integer;
Begin
    // Get repository
    MB := MetabaseClass.Active;
    // Get express report
    Express := MB.ItemById("EXPRESS").Edit As IEaxAnalyzer;
    // Get table display settings
    Pivot := Express.Pivot;
    // Get the collection of dimension located by rows
    LeftHeader := Pivot.LeftHeader;
    // Display names of obtained dimensions
    Count := LeftHeader.DimCount;
    For i := 0 To Count-1 Do
        Dim := LeftHeader.PivotDim(i);
        Debug.WriteLine("Dimension: " + Dim.DimInstance.Name);
    End For;
    // Enable use of stair hierarchy
    LeftHeader.StairsHierarchy := True;
    // Get table row header properties
    TableHeader := Pivot.ObtainTable.LeftHeader;
    // Check if element with the (1,0) coordinate is a hierarchy stair
    If Not TableHeader.IsStairElement(1, 0) Then
        Debug.WriteLine
        ("The " + TableHeader.ElementName(1, 0) + " element of table row header is not a hierarchy stair") Else
        Debug.WriteLine
        ("Element of table row header is a hierarchy stair");
    End If;
    // Save changes
    (Express As IMetabaseObject).Save;
End Sub UserProc;

After executing the example the table sidehead displays stairs hierarchy. The console displays names of the dimensions located by rows, and whether the element with the (1,0) coordinate is a hierarchy stair. For example:

Dimension: Territories

Dimension: Data types

Table row header element is a hierarchy stair