Class GroupSettings

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
System.Object
GroupSettings
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.EJ2.Pivot
Assembly: Syncfusion.EJ2.Pivot.dll
Syntax
public class GroupSettings

Constructors

GroupSettings()

Declaration
public GroupSettings()

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
public string Caption { get; set; }
Property Value
Type
System.String

CustomGroups

It allows to set the custom group information to create custom group fields.

It is applicable only for custom grouping.

Declaration
public List<CustomGroups> CustomGroups { get; set; }
Property Value
Type
System.Collections.Generic.List<CustomGroups>

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
public string EndingAt { get; set; }
Property Value
Type
System.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 - Specifies the group as years. Quarters - Specifies the group as quarters. Months - Specifies the group as months. Days - Specifies the group as days. Hours - Specifies the group as hours. Minutes - Specifies the group as minutes. Seconds - Specifies the group as seconds.

Declaration
public List<DateGroup> GroupInterval { get; set; }
Property Value
Type
System.Collections.Generic.List<DateGroup>

Name

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

Declaration
public string Name { get; set; }
Property Value
Type
System.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
public int RangeInterval { get; set; }
Property Value
Type
System.Int32

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
public string StartingAt { get; set; }
Property Value
Type
System.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
public GroupType Type { get; set; }
Property Value
Type
GroupType