Class PivotViewGroupingBarSettings

Allows a set of options for customizing the grouping bar UI with a variety of settings such as UI visibility to a specific view port, customizing the pivot button features such as filtering, sorting, changing aggregate types, removing any fields. The options available to customize the grouping bar UI are: ShowFilterIcon: Allows you to show or hide the filter icon that used to be displayed on the pivot button of the grouping bar UI. This filter icon is used to filter the members of a particular field at runtime in the pivot table. ShowSortIcon: Allows you to show or hide the sort icon that used to be displayed in the pivot button of the grouping bar UI. This sort icon is used to order members of a particular fields either in ascending or descending at runtime. ShowRemoveIcon: Allows you to show or hide the remove icon that used to be displayed in the pivot button of the grouping bar UI. This remove icon is used to remove any field during runtime. ShowValueTypeIcon: Allows you to show or hide the value type icon that used to be displayed in the pivot button of the grouping bar UI. This value type icon helps to select the appropriate aggregation type to value fields at runtime. DisplayMode: Allow options to show the grouping bar UI to specific view port such as either pivot table or pivot chart or both table and chart. For example, to show the grouping bar UI to pivot table on its own, set the property displayMode to Table. AllowDragAndDrop: Allows you to restrict the pivot buttons that were used to drag on runtime in the grouping bar UI. This will prevent you from modifying the current report.

Inheritance

System.Object

PivotViewGroupingBarSettings

Namespace: Syncfusion.Blazor.PivotView

Assembly: Syncfusion.Blazor.dll

Syntax

public class PivotViewGroupingBarSettings : OwningComponentBase

Constructors

PivotViewGroupingBarSettings()

Declaration

public PivotViewGroupingBarSettings()

Properties

AllowDragAndDrop

Allows you to restrict the pivot buttons that were used to drag on runtime in the grouping bar UI. This will prevent you from modifying the current report.

By default, all fields are available for drag-and-drop operation in the grouping bar.

Declaration

public bool AllowDragAndDrop { get; set; }

Property Value

Type	Description
System.Boolean

DisplayMode

Allow options to show the grouping bar UI to specific view port such as either pivot table or pivot chart or both table and chart. For example, to show the grouping bar UI to pivot table on its own, set the property DisplayMode to Table.

By default, the grouping bar UI will be shown to both pivot table as well as pivot chart.

Declaration

public View DisplayMode { get; set; }

Property Value

Type	Description
View

ShowFieldsPanel

Allows you to show an additional UI along with the grouping bar UI, which contains the fields that aren't bound in the current report. It allows you to modify the report by re-arranging the pivot buttons through drag-and-drop operation between axes (row, column, value and filter) that are used to update the pivot table during runtime.

This property is applicable only for relational data source.

Declaration

public bool ShowFieldsPanel { get; set; }

Property Value

Type	Description
System.Boolean

ShowFilterIcon

Allows you to show or hide the filter icon that used to be displayed on the pivot button of the grouping bar UI. This filter icon is used to filter the members of a particular field at runtime in the pivot table.

By default, the filter icon is enabled in the grouping bar.

Declaration

public bool ShowFilterIcon { get; set; }

Property Value

Type	Description
System.Boolean

ShowRemoveIcon

Allows you to show or hide the remove icon that used to be displayed in the pivot button of the grouping bar UI. This remove icon is used to remove any field during runtime.

By default, the remove icon is enabled in the grouping bar.

Declaration

public bool ShowRemoveIcon { get; set; }

Property Value

Type	Description
System.Boolean

ShowSortIcon

Allows you to show or hide the sort icon that used to be displayed in the pivot button of the grouping bar UI. This sort icon is used to order members of a particular fields either in ascending or descending at runtime.

By default, the sort icon is enabled in the grouping bar.

Declaration

public bool ShowSortIcon { get; set; }

Property Value

Type	Description
System.Boolean

ShowValueTypeIcon

Allows you to show or hide the value type icon that used to be displayed in the pivot button of the grouping bar UI. This value type icon helps to select the appropriate aggregation type to value fields at runtime.

By default, the icon to set aggregate types is enabled in the grouping bar.

Declaration

public bool ShowValueTypeIcon { get; set; }

Property Value

Type	Description
System.Boolean

Methods

Dispose()

Dispose the unmanaged resources.

Declaration

public virtual void Dispose()

Dispose(Boolean)

Dispose unmanaged resources in the component.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	Boolean value to dispose the object.

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
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing any asynchronous operation.

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
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing any asynchronous operation.