Class PivotViewFilter
Represents a filter field configuration for the SfPivotView<TValue> component's filter axis.
Inheritance
Inherited Members
Namespace: Syncfusion.Blazor.PivotView
Assembly: Syncfusion.Blazor.dll
Syntax
public class PivotViewFilter : PivotFieldOptions, IComponent, IHandleEvent, IHandleAfterRender, IDisposableRemarks
The PivotViewFilter class defines configuration settings for fields in the filter axis of the pivot table. Filter fields enable filtering of values across other axes (rows, columns, and values) based on the selected members in the filter axis. Each filter field configuration specifies how the field should appear and behave in the grouping bar and field list UI, including display properties and interaction features.
The following configurations are applicable for filter fields:
Name: Specifies the field name that will be displayed in the row/column/value/filter axis of the pivot table.Caption: Specifies the caption for the specific field. The caption will be used to display instead of the field name in the pivot table component's UI.IsNamedSet: Specifies whether the field is a named set or not. In general, the named set is a set of dimension members or a set expression (MDX query) to be created as a dimension in the SSAS OLAP cube itself. Note: Applicable only for OLAP data sources.IsCalculatedField: Specifies whether the field is a calculated field or not. In general, the calculated field is created from the bound data source or using simple formulas with basic arithmetic operators in the pivot table. Note: Applicable only for OLAP data sources.ShowFilterIcon: Shows or hides the filter icon of a specific field that is displayed on the pivot button of the grouping bar and field list UI. This filter icon is used to filter the members of a specified field at runtime in the pivot table.ShowRemoveIcon: Shows or hides the remove icon of a specific field that is displayed in the pivot button of the grouping bar and field list UI. This remove icon is used to remove the specified field during runtime.ShowEditIcon: Shows or hides the edit icon of a specific field that is displayed on the pivot button of the grouping bar and field list UI. This edit icon is used to modify the caption, formula, and format of a specified calculated field at runtime that is displayed in the pivot table.AllowDragAndDrop: Restricts the specific field's pivot button from being dragged at runtime in the grouping bar and field list UI. This prevents modification of the current report.ExpandAll: Expands or collapses all of the pivot table's headers for a specific field.
Constructors
PivotViewFilter()
Declaration
public PivotViewFilter()Methods
Dispose(bool)
Dispose unmanaged resources in the component.
Declaration
protected override void Dispose(bool disposing)Parameters
| Type | Name | Description |
|---|---|---|
| bool | disposing |
Overrides
OnInitializedAsync()
Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree. Override this method if you will perform an asynchronous operation and want the component to refresh when that operation is completed.
Declaration
protected override Task OnInitializedAsync()Returns
| Type | Description |
|---|---|
| Task | A System.Threading.Tasks.Task representing any asynchronous operation. |
Overrides
OnParametersSetAsync()
Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.
Declaration
protected override Task OnParametersSetAsync()Returns
| Type | Description |
|---|---|
| Task | A System.Threading.Tasks.Task representing any asynchronous operation. |