Class PivotGroupSetting

Allows specific fields to group their data on the basis of their type. For example, the date type fields can be formatted and displayed based on year, quarter, month, and more. Likewise, the number type fields can be grouped range-wise, such as 1-5, 6-10, etc. You can perform custom group to the string type fields that used to displayed in the pivot table.

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

Constructors

PivotGroupSetting()

Declaration
public PivotGroupSetting()

Properties

Caption

It allows to set the caption to custom field that will be used to created from custom group fields in the pivot table.

It is applicable only for custom grouping.

Declaration
[Parameter]
[JsonPropertyName("caption")]
public string Caption { get; set; }
Property Value
Type
string

EndingAt

It allows to set the start value/date to group fields to the specified range that to be displayed in the pivot table.

Declaration
[Parameter]
[JsonPropertyName("endingAt")]
public string EndingAt { get; set; }
Property Value
Type
string

GroupInterval

It allows to specify the date group intervals such as years or quarter or months or days or hours or minutes or seconds to group fields based on that in the pivot table. They options are: Years - Defines group field as 'Years' for date type field. Quarters - Defines group field as 'Quarters' for date type field. QuarterYear - Defines group field as 'Quarter Year' for date type field. Months - Defines group field as 'Months' for date type field. Days - Defines group field as 'Days' for date type field. Hours - Defines group field as 'Hours' for date type field. Minutes - Defines group field as 'Minutes' for date type field. Seconds - Defines group field as 'Seconds' for date type field.

Declaration
[Parameter]
[JsonPropertyName("groupInterval")]
public List<DateGroup> GroupInterval { get; set; }
Property Value
Type
List<DateGroup>

Name

It allows to set the specific field name to apply group settings.

Declaration
[Parameter]
[JsonPropertyName("name")]
public string Name { get; set; }
Property Value
Type
string

RangeInterval

It allows to set the interval range to group field based on the specified range.

It is applicable only of number type grouping.

Declaration
[Parameter]
[JsonPropertyName("rangeInterval")]
public double RangeInterval { get; set; }
Property Value
Type
double

StartingAt

It allows to set the start value/date to group fields from the specified range that to be displayed in the pivot table.

Declaration
[Parameter]
[JsonPropertyName("startingAt")]
public string StartingAt { get; set; }
Property Value
Type
string

Type

It allows to set the type as date or number or custom to the specified field for apply grouping. The types are: Date - Defines group type as 'Date' for date type field Number - Defines group type as 'Number' for numeric type field. Custom - Defines group type as 'Custom' for custom group field.

Declaration
[Parameter]
[JsonPropertyName("type")]
[JsonConverter(typeof(JsonStringEnumConverter))]
public GroupType Type { get; set; }
Property Value
Type
GroupType

Implements