Class PivotViewValueSortSettings

Represents value-based sorting configuration for the SfPivotView<TValue> component.

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

The PivotViewValueSortSettings class defines configuration settings for sorting pivot table data based on aggregated values rather than member labels. Value-based sorting enables sorting of row or column headers based on the aggregated numeric values of a specified measure, in either ascending or descending order. This is particularly useful for identifying top or bottom performers, highest or lowest values, and other value-driven analytical scenarios.

The following configurations control value-based sorting behavior:

  • HeaderDelimiter: Specifies the delimiter character or string used to separate hierarchical header levels when constructing the header text for value sorting. The delimiter is used to parse and match multi-level row or column headers in the pivot table.
  • HeaderText: Specifies the complete header text that identifies the specific row or column header whose values will be used as the sorting basis. For hierarchical headers, the header text should include all levels separated by the specified delimiter. This property is used for general value sorting that applies to both row and column axes.
  • Measure: Specifies the name of the value field (measure) whose aggregated values will be used for sorting. The measure name should match one of the fields configured in the Values axis of the pivot table. When multiple value fields exist, this property determines which measure's values control the sort order.
  • SortOrder: Specifies the sort direction for the aggregated values, either ascending or descending. Ascending order displays the smallest values first, while descending order displays the largest values first. This property is used for general value sorting that applies to both row and column axes.
  • RowHeaderText: Specifies the row header text that identifies the specific row header whose values will be used as the sorting basis for row-specific value sorting. For hierarchical row headers, the header text should include all levels separated by the specified delimiter. This property enables independent sorting configuration for the row axis.
  • ColumnHeaderText: Specifies the column header text that identifies the specific column header whose values will be used as the sorting basis for column-specific value sorting. For hierarchical column headers, the header text should include all levels separated by the specified delimiter. This property enables independent sorting configuration for the column axis.
  • RowSortOrder: Specifies the sort direction for row-specific value sorting, either ascending or descending. This property controls the sort order specifically for the row axis, independent of column axis sorting.
  • ColumnSortOrder: Specifies the sort direction for column-specific value sorting, either ascending or descending. This property controls the sort order specifically for the column axis, independent of row axis sorting.

Constructors

PivotViewValueSortSettings()

Declaration
public PivotViewValueSortSettings()

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