Class PivotViewGroupSettingBuilder
Inheritance
Namespace: Syncfusion.EJ2.PivotView
Assembly: Syncfusion.EJ2.dll
Syntax
public class PivotViewGroupSettingBuilder : ControlBuilderConstructors
PivotViewGroupSettingBuilder()
Declaration
public PivotViewGroupSettingBuilder()PivotViewGroupSettingBuilder(List<PivotViewGroupSetting>)
Declaration
public PivotViewGroupSettingBuilder(List<PivotViewGroupSetting> collection)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<PivotViewGroupSetting> | collection |
Methods
Add()
Declaration
public void Add()Caption(String)
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 PivotViewGroupSettingBuilder Caption(string caption)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | caption |
Returns
CustomGroups(Action<PivotViewCustomGroupBuilder>)
Declaration
public PivotViewGroupSettingBuilder CustomGroups(Action<PivotViewCustomGroupBuilder> customGroups)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<PivotViewCustomGroupBuilder> | customGroups |
Returns
CustomGroups(List<PivotViewCustomGroup>)
It allows to set the custom group information to create custom group fields.
It is applicable only for custom grouping.
Declaration
public PivotViewGroupSettingBuilder CustomGroups(List<PivotViewCustomGroup> customGroups)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<PivotViewCustomGroup> | customGroups |
Returns
EndingAt(Double)
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 PivotViewGroupSettingBuilder EndingAt(double endingAt)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | endingAt |
Returns
EndingAt(String)
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 PivotViewGroupSettingBuilder EndingAt(string endingAt)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | endingAt |
Returns
GroupInterval(Object)
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
public PivotViewGroupSettingBuilder GroupInterval(object groupInterval)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | groupInterval |
Returns
Name(String)
It allows to set the specific field name to apply group settings.
Declaration
public PivotViewGroupSettingBuilder Name(string name)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name |
Returns
RangeInterval(Double)
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 PivotViewGroupSettingBuilder RangeInterval(double rangeInterval)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | rangeInterval |
Returns
StartingAt(Double)
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 PivotViewGroupSettingBuilder StartingAt(double startingAt)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | startingAt |
Returns
StartingAt(String)
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 PivotViewGroupSettingBuilder StartingAt(string startingAt)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | startingAt |
Returns
Type(GroupType)
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 PivotViewGroupSettingBuilder Type(GroupType type)Parameters
| Type | Name | Description |
|---|---|---|
| GroupType | type |