IPivotHeader.Settings

Fore Syntax

Settings: IPivotHeaderSettings;

Fore.NET Syntax

Settings: Prognoz.Platform.Interop.Pivot.IPivotHeaderSettings;

Description

The Settings property returns table header settings.

Comments

Table header settings store:

Dimension data filtering settings.
Settings for working with leaf elements.

Fore Example

Executing the example requires that the repository contains an express report with the EXPRESS identifier. The report contains a table.

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

Sub UserProc;
Var
    MB: IMetabase;
    Express: IEaxAnalyzer;
    Pivot: IPivot;
    LeftHeader: IPivotHeader;
    TableHeader: IPivotTableHeader;
    PivSettings: IPivotHeaderSettings;
Begin
    // Get repository
    MB := MetabaseClass.Active;
    // Get express report
    Express := MB.ItemById("EXPRESS").Edit As IEaxAnalyzer;
    // Get display settings of report data table
    Pivot := Express.Pivot;
    // Get collection of dimensions located by rows
    LeftHeader := Pivot.LeftHeader;
    // Get settings of dimensions located by rows
    PivSettings := LeftHeader.Settings;
    // Enable displaying of only leaf elements
    If Not PivSettings.IsLeafElementsOnly Then
        PivSettings.LeafElementsOnly := TriState.OnOption;
    End If;
    // Save changes
    (Express As IMetabaseObject).Save;
End Sub UserProc;

After executing the example table sidehead displays only the elements that have no selected child ones.

Fore.NET Example

The requirements and result of the Fore.NET example execution match with those in the Fore example.

Imports Prognoz.Platform.Interop.Express;
Imports Prognoz.Platform.Interop.ForeSystem;
Imports Prognoz.Platform.Interop.Pivot;
…
Public Shared Sub Main(Params: StartParams);
Var
    MB: IMetabase;
    Express: IEaxAnalyzer;
    Pivot: IPivot;
    LeftHeader: IPivotHeader;
    TableHeader: IPivotTableHeader;
    PivSettings: IPivotHeaderSettings;
Begin
    // Get repository
    MB := Params.Metabase;
    // Get express report
    Express := MB.ItemById["EXPRESS"].Edit() As IEaxAnalyzer;
    // Get display settings of report data table
    Pivot := Express.Pivot;
    // Get collection of dimensions located by rows
    LeftHeader := Pivot.LeftHeader;
    // Get settings of dimensions located by rows
    PivSettings := LeftHeader.Settings;
    // Enable displaying of only leaf elements
    If Not PivSettings.IsLeafElementsOnly Then
        PivSettings.LeafElementsOnly := TriState.tsOnOption;
    End If;
    // Save changes
    (Express As IMetabaseObject).Save();
End Sub;