Class PivotViewSortSetting

Represents a sort setting configuration for ordering field members in the SfPivotView<TValue> component.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
PivotSortSetting
PivotViewSortSetting
Implements
Inherited Members
Namespace: Syncfusion.Blazor.PivotView
Assembly: Syncfusion.Blazor.dll
Syntax
public class PivotViewSortSetting : PivotSortSetting, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Remarks

The PivotViewSortSetting class defines configuration settings for sorting members of specific fields in the pivot table. Sorting can be applied to fields in any axis (rows, columns, filters, or values) to order the field members in either ascending or descending sequence. By default, fields are displayed in ascending order based on the data source. Sorting behavior is controlled by the EnableSorting property of the pivot table component, which must be set to true to enable custom sort settings. The Order property in the PivotViewSortSettings class defaults to Sorting.Ascending. To preserve the original data-source ordering, set Order to Sorting.None; doing so also removes the sort icons from the grouping bar and field list buttons for the corresponding field.

The following configurations control field-level sorting behavior:

  • Name: Specifies the field name to which the sort setting applies. The field name must match one of the fields configured in the pivot table's data source settings (rows, columns, values, or filters). Only members of the specified field are affected by this sort configuration.
  • Order: Specifies the sort direction for the field's members, either ascending or descending. Ascending order arranges members from lowest to highest (alphabetically A-Z for text, numerically smallest to largest for numbers, earliest to latest for dates). Descending order arranges members from highest to lowest (alphabetically Z-A for text, numerically largest to smallest for numbers, latest to earliest for dates). The default sort order is ascending if no sort setting is explicitly configured.

Sort settings are applied during the initial rendering of the pivot table and whenever the data source is refreshed. Multiple sort settings can be configured for different fields, with each field maintaining its independent sort order. Member-level sorting is distinct from value-based sorting, which orders headers based on aggregated numeric values rather than member labels.

Constructors

PivotViewSortSetting()

Declaration
public PivotViewSortSetting()

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.
Overrides

Implements