Class PivotViewFilterSettingBuilder
Inheritance
Namespace: Syncfusion.EJ2.PivotView
Assembly: Syncfusion.EJ2.dll
Syntax
public class PivotViewFilterSettingBuilder : ControlBuilderConstructors
PivotViewFilterSettingBuilder()
Declaration
public PivotViewFilterSettingBuilder()PivotViewFilterSettingBuilder(List<PivotViewFilterSetting>)
Declaration
public PivotViewFilterSettingBuilder(List<PivotViewFilterSetting> collection)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<PivotViewFilterSetting> | collection |
Methods
Add()
Declaration
public void Add()Condition(Operators)
Allows you to choose the operator type such as equals, greater than, less than, etc. for conditional-based filtering.
It is applicable only for label and value filtering.
Declaration
public PivotViewFilterSettingBuilder Condition(Operators condition)Parameters
| Type | Name | Description |
|---|---|---|
| Operators | condition |
Returns
Items(String[])
Allows you to specify the field members that used to be displayed based on the filter type provided in the pivot table.
Declaration
public PivotViewFilterSettingBuilder Items(string[] items)Parameters
| Type | Name | Description |
|---|---|---|
| System.String[] | items |
Returns
LevelCount(Int32)
Allows to set level of the field to fetch data from the cube for filtering.
This option is applicable only for user-defined hierarchies in OLAP data source.
Declaration
public PivotViewFilterSettingBuilder LevelCount(int levelCount)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | levelCount |
Returns
Measure(String)
Allows to set value field for evaluation using conditions and operands for filtering.
It is applicable only for label and value filtering.
Declaration
public PivotViewFilterSettingBuilder Measure(string measure)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | measure |
Returns
Name(String)
Allows you to set the field name that used to display the selective or conditional-based filter members that used to be displayed in the pivot table.
Declaration
public PivotViewFilterSettingBuilder Name(string name)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name |
Returns
SelectedField(String)
Allows to set level name of a specified field, where the filtering settings to be applied.
This option is applicable only for user-defined hierarchies in OLAP data source.
Declaration
public PivotViewFilterSettingBuilder SelectedField(string selectedField)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | selectedField |
Returns
Type(FilterType)
Allows you to set the specific filter type to display the filter members in the pivot table. They are: Include - Specifies the filter type as include for member filter. Exclude - Specifies the filter type as exclude for member filter. Label - Specifies the filter type as label for header filter. Date - Specifies the filter type as date for date based filter. Number - Specifies the filter type as number for number based filter. Value - Specifies the filter type as value for value based filter.
Declaration
public PivotViewFilterSettingBuilder Type(FilterType type)Parameters
| Type | Name | Description |
|---|---|---|
| FilterType | type |
Returns
Value1(String)
Allows you to set the start value to display the filter items in the pivot table based on the condition applied.
It is applicable only for label and value filtering.
Declaration
public PivotViewFilterSettingBuilder Value1(string value1)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value1 |
Returns
Value2(String)
Allows you to set the end value to display the filter items in the pivot table based on the condition applied.
This option will be used by default when the operator Between and NotBetween is chosen to apply. Also, it is applicable only for label and value filtering.
Declaration
public PivotViewFilterSettingBuilder Value2(string value2)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value2 |