Properties of slice axis filters
Slice axis filters are defined hierarchically. Use SETPROPERTY to define filters.
This table shows the hierarchical structure of a value filter that checks rows for values greater than 35000:
Row | NodeType | Operator Type | Enabled | Parent | Aggregation | Filter Type | Include Other Axis | Value | Condition | Tuple | Set |
---|---|---|---|---|---|---|---|---|---|---|---|
1 | OPERATOR | AND | TRUE | ||||||||
2 | FILTER | TRUE | 1 | ANY | VALUE | FALSE | 35000 | > | Tuple | Set |
In the table, the value of the IncludeOtherAxis property is FALSE. That is, the filter checks values in an area of data that is not displayed in the columns of the report. For example,a report displays periods on the rows and the Units measure on the columns. You create a filter to display Units only where the value of the Gross Margin measure is greater than a specified amount. If you set IncludeOtherAxis to TRUE, the filter would check values in the Units column.
This SETPROPERTY function creates the XML with the same structure as the table:
=SETPROPERTY("","key1","NodeType","Operator","OperatorType","AND","Enabled","True",
"Nodetype","Filter","Enabled","True","Parent",1,"Aggregation","Any","FilterType","value","Includeotheraxis","False","value",35000,"condition","GreaterThan",
"Tuple","[measure].defaultmember,[period].defaultmember,[pos].defaultmember,[product].defaultmember,[region].defaultmember,[channel].defaultmember,[valtype].defaultmember",
"set","{[measure].[gross margin]}")
This list shows the properties that are supported by value and attribute filters:
- NodeType
- The value of the NodeType property can be OPERATOR OR FILTER.
- OperatorType
- The value of the OperatorType property can be AND or OR.
- Enabled
- The value of the Enabled property can be TRUE or FALSE.
- Parent
- The parent property contains information about the NodeId. The root NodeId (1 in the example) does not have a parent.
- Aggregation
- For value filters, these are the supported aggregation types:
- Any
- Sum
- Minimum
- Maximum
- Average
- FilterType
- The filter type can be Value, Attribute, or MDX.
- IncludeOtherAxis
- The property specifies whether to filter by the values displayed in the report or by some other value. For example, you have financial quarters on the rows and unit sales on the columns. You could create a filter on the row axis to display only the quarters in which unit sales were above a specified value. In this case, you would specify TRUE. That is, the filter would reference the values displayed on the other, column, axis. But to display the quarters with unit sales where the gross margin was above a specified value, you would specify FALSE and then specify gross margin in the data area. That is, the filter would not reference the values on the column axis but those of another column, not displayed in the report.
- Condition
- These conditions are supported:
- None
- Equals
- LessThan
- GreaterThan
- LessOrEqual
- Between
- NotBetween
- Contains
- ContainsNot
- InList
- NotInList
- IsAccessible - value filters only
- Tuple
- A valid MDX expression that returns a tuple.
- Set
- A valid MDX expression that returns a set.
- Hierarchy
- In an attribute filter, the unique name of the hierarchy is required.
- AttributeFilterType
- In an attribute filter, these properties are supported:
- String
- Number
- Wildcard
- RegularExpression
- MDX
- Custom defined valid MDX filter.
- Enabled
- TRUE or FALSE.