IPivot.BroughtOutDimValue

Fore Syntax

BroughtOutDimValue: Integer;

Fore.NET Syntax

BroughtOutDimValue: integer;

Description

The BroughtOutDimValue property determines index of metrics dimension element on using the Value».

Comments

To use the property, determine metrics dimension in the IPivot.BroughtOutDim property.

If value of this property is not specified, table is built by the first element in selection.

Fore Example

Executing the example requires that the repository contains an express report with the EXPRESS identifier containing a table. The role of one of the dimensions is Metrics.

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

Sub UserProc;
Var
    MB: IMetabase;
    Express: IEaxAnalyzer;
    Pivot: IPivot;
    DimInst: IDimInstance;
Begin
    // Get repository
    MB := MetabaseClass.Active;
    // Get express report
    Express := MB.ItemById("EXPRESS").Bind As IEaxAnalyzer;
    // Get display settings of report data table
    Pivot := Express.Pivot;
    // Get data of the specified dimension
    DimInst := Pivot.BroughtOutDim;
        // Display in console window
        If DimInst <> Null Then
            Debug.WriteLine("Metrics dimension - " + DimInst.Name);
            Debug.WriteLine("Attribute name - " + DimInst.Elements.Name(Pivot.BroughtOutDimValue));
            Debug.WriteLine("Index of metrics dimension element - " + Pivot.BroughtOutDimValue.ToString);
        Else
            Debug.WriteLine("Specified dimension is not a metrics dimension");
        End If;
End Sub UserProc;

After executing the example the console window displays metrics dimension name, attribute name, index of metrics dimension element.

Fore.NET Example

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

Imports Prognoz.Platform.Interop.Dimensions;
Imports Prognoz.Platform.Interop.Express;
Imports Prognoz.Platform.Interop.Pivot;
…
Public Shared Sub Main(Params: StartParams);
Var
    MB: IMetabase;
    Express: IEaxAnalyzer;
    Pivot: IPivot;
    DimInst: IDimInstance;
Begin
    // Get repository
    MB := Params.Metabase;
    // Get express report
    Express := MB.ItemById["EXPRESS"].Bind() As IEaxAnalyzer;
    // Get display settings of report data table
    Pivot := Express.Pivot;
    // Get data of the specified dimension
    DimInst := Pivot.BroughtOutDim;
        // Display in console window
        If DimInst <> Null Then
            System.Diagnostics.Debug.WriteLine
            ("Metrics dimension - " + DimInst.Name);
            System.Diagnostics.Debug.WriteLine
            ("Attribute name - " + DimInst.Elements.Name[Pivot.BroughtOutDimValue]);
            System.Diagnostics.Debug.WriteLine
            ("Index of metrics dimension element - " + Pivot.BroughtOutDimValue.ToString());
        Else
            System.Diagnostics.Debug.WriteLine
            ("Specified dimension is not a metrics dimension");
        End If;
End Sub;