PivotFieldGroupOptions
PivotFieldGroupOptions class
Options for pivot field grouping settings.
class PivotFieldGroupOptions;
Constructors
| Name | Description |
|---|---|
| constructor() | Default Constructor. |
Properties
| Property | Type | Description |
|---|---|---|
| isAutoStart | boolean | Gets or sets a value indicating whether the start value is automatically determined. |
| isAutoEnd | boolean | Gets or sets a value indicating whether the end value is automatically determined. |
| startNumber | number | Gets or sets the start value of the grouping range. |
| endNumber | number | Gets or sets the end value of the grouping range. |
| startDate | Date | Gets or sets the start value of the grouping range. |
| endDate | Date | Gets or sets the end value of the grouping range. |
| interval | number | Gets or sets the interval size for each group. |
| groupType | PivotGroupByType | Gets or sets the grouping type for pivot field. Only for grouping date time pivot field. |
| groupTypes | PivotGroupByType[] | Gets or sets the grouping type for pivot field. |
| newPivotField | boolean | Gets or sets a value indicating whether new pivot fields should be created after grouping. |
constructor()
Default Constructor.
constructor();
isAutoStart
Gets or sets a value indicating whether the start value is automatically determined.
isAutoStart : boolean;
Remarks
If StartNumber or StartDate is set, this property will be false.
isAutoEnd
Gets or sets a value indicating whether the end value is automatically determined.
isAutoEnd : boolean;
Remarks
If EndNumber or EndDate is set, this property will be false.
startNumber
Gets or sets the start value of the grouping range.
startNumber : number;
endNumber
Gets or sets the end value of the grouping range.
endNumber : number;
startDate
Gets or sets the start value of the grouping range.
startDate : Date;
endDate
Gets or sets the end value of the grouping range.
endDate : Date;
interval
Gets or sets the interval size for each group.
interval : number;
Remarks
Only for number and days group.
groupType
Gets or sets the grouping type for pivot field. Only for grouping date time pivot field.
groupType : PivotGroupByType;
groupTypes
Gets or sets the grouping type for pivot field.
groupTypes : PivotGroupByType[];
Remarks
The order in this property will be ignored. When specifying multiple group types, base group fields will be inserted in ascending order and show group field to row/column region in descending order (Years → Quarters → Months → Days → Hours → Minutes → Seconds).
newPivotField
Gets or sets a value indicating whether new pivot fields should be created after grouping.
newPivotField : boolean;
Remarks
If not explicitly set, the default value is false for numeric grouping and true for date-time grouping. Only works for the first new group pivot field of the base field.
