AddFilter (Method)

Applies To:

OLAPLabel object

Description:

Adds a new filter value and returns an object that represents the new item.

The AddFilter (Method) uses all operator types for side labels and measures for all supported OLAP engines.

The AddFilterValue (Method) supports only the Select MembersFromDatabase operator type.

Syntax:

Expression.AddFilter(BqOperatorType operatorType, BqOperator dataOperator, String value1, String value2, [optional] Boolean IsVariable]

Expression Required:

An expression that returns an object for an OLAPLabel object

Constants:

The AddFilter (Method) uses the BqOperatorType and BqOperator constant groups.

The BqOperatorType constant group consists of these values:

bqOperatorTypeBottomN
bqOperatorTypeBottomNPercent
bqOperatorTypeBottomSum
bqOperatorTypeMeasure
bqOperatorTypeSelectByMeasure
bqOperatorTypeSelectMembers
bqOperatorTypeSelectMembersFromDB
bqOperatorTypeSelectMembersFromFile
bqOperatorTypeSubstitutionVariables
bqOperatorTypeTopN
bqOperatorTypeTopNPercent
bqOperatorTypeTopSum
bqOperatorTypeUDA
bqOperatorTypeUndefined

The BqOperator constant group consists of these values:

bqOperatorEqual
bqOperatorGreaterThan
bqOperatorGreaterThanOrEqual
bqOperatorLessThan
bqOperatorLessThanOrEqual
bqOperatorMatchMember
bqOperatorNotEqual
bqOperatorUndefined

Example 1:

This example shows how to add a filter to the Product Family top label equal to the “Drink” database member. The filter value was not made a variable:

ActiveDocument.Sections["OLAPQuery"].TopLabels["Product Family"].AddFilter(bqOperatorTypeSelectMembersFromDB,  bqOperatorEqual, "Drink", false)

Example 2:

This example shows how to add a Top N filter to the Product Family side label. The filter value retrieves only one Product Family member with the top value of the Store Invoice measure.

ActiveDocument.Sections["OLAPQuery"].SideLabels["Product Family"].AddFilter(bqOperatorTypeTopN, bqOperatorUndefined, "1","Store Invoice", false)