Class PivotViewGroupSetting

Represents grouping configuration for a single field in the Pivot Table.

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

Supports grouping by data type:

  • Date fields can be grouped by intervals such as years, quarters, or months.
  • Number fields can be grouped into ranges (for example, 1–5, 6–10).
  • String fields can be grouped into custom categories.

Used within PivotViewGroupSettings to define one or more group rules.

Constructors

PivotViewGroupSetting()

Declaration
public PivotViewGroupSetting()

Properties

CustomGroups

Gets or sets custom group definitions for the field. Applicable only when GroupType is Custom.

Declaration
[Parameter]
[JsonPropertyName("customGroups")]
public List<PivotViewCustomGroup> CustomGroups { get; set; }
Property Value
Type Description
List<PivotViewCustomGroup>

A List<T> of PivotViewCustomGroup items that define custom categories. The default value is an empty collection.
Remarks

Custom groups categorize members into named buckets and are reflected in row and column headers.

Runtime grouping can be performed from the context menu when multiple headers of the same field are selected.

Examples

The following example creates custom groups for a Product field:

<PivotViewGroupSettings>
  <PivotViewGroupSetting Name="Product" Type="GroupType.Custom">
    <PivotViewCustomGroups>
      <PivotViewCustomGroup Caption="Beverages"
                             Items="@(new string[] { "Tea", "Coffee" })" />
      <PivotViewCustomGroup Caption="Snacks"
                             Items="@(new string[] { "Chips", "Nuts" })" />
    </PivotViewCustomGroups>
  </PivotViewGroupSetting>
</PivotViewGroupSettings>
See Also

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

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