IPivot.FilterHeader

Syntax

Description

The FilterHeader property returns the collection of dimensions used as a cube filter.

Comments

The property is relevant if a table is based on a standard cube, in which fact aggregation is set up. The dimensions included in the FilterHeader collection will be excluded from the cube data query. Regardless of the selection set in the dimensions, selection by such dimensions will be considered as full.

NOTE. Working with filtering dimensions is available only in the web application.

Example

Executing the example requires that the repository contains an express report with the EXPRESS_REPORT identifier. The report is based on a standard cube, in which fact aggregation is set up, and the cube contains a dimension with the D_COMPANY identifier. Execute the specified example in the web application.

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

Sub UserProc;
Var
    MB: IMetabase;
    Express: IEaxAnalyzer;
    Pivot: IPivot;
Begin
    // Get repository
    MB := MetabaseClass.Active;
    // Get express report
    Express := MB.ItemById("EXPRESS_REPORT").Edit As IEaxAnalyzer;
    // Get settings for displaying report data table
    Pivot := Express.Pivot;
    // Include dimension in filter
    Pivot.FilterHeader.AddDim(Pivot.Dimensions.FindByKey(Mb.GetObjectKeyById("D_COMPANY")).DimInstance);
    // Save changes
    (Express As IMetabaseObject).Save;
End Sub UserProc;

After executing the example the specified dimension is included in the list of filtering dimensions, and it is no used on data extraction.