PivotFieldGroupOptions

• Open Markdown

• ---

• Open in ChatGPT
• Open in Claude
• Open in Perplexity

PivotFieldGroupOptions class

Options for pivot field grouping settings.

class PivotFieldGroupOptions;

Constructors

Constructor	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.

Methods

Method	Description
isAutoStart()	@deprecated. Please use the ‘isAutoStart’ property instead. Gets or sets a value indicating whether the start value is automatically determined.
setIsAutoStart(boolean)	@deprecated. Please use the ‘isAutoStart’ property instead. Gets or sets a value indicating whether the start value is automatically determined.
isAutoEnd()	@deprecated. Please use the ‘isAutoEnd’ property instead. Gets or sets a value indicating whether the end value is automatically determined.
setIsAutoEnd(boolean)	@deprecated. Please use the ‘isAutoEnd’ property instead. Gets or sets a value indicating whether the end value is automatically determined.
getStartNumber()	@deprecated. Please use the ‘startNumber’ property instead. Gets or sets the start value of the grouping range.
setStartNumber(number)	@deprecated. Please use the ‘startNumber’ property instead. Gets or sets the start value of the grouping range.
getEndNumber()	@deprecated. Please use the ’endNumber’ property instead. Gets or sets the end value of the grouping range.
setEndNumber(number)	@deprecated. Please use the ’endNumber’ property instead. Gets or sets the end value of the grouping range.
getStartDate()	@deprecated. Please use the ‘startDate’ property instead. Gets or sets the start value of the grouping range.
setStartDate(Date)	@deprecated. Please use the ‘startDate’ property instead. Gets or sets the start value of the grouping range.
getEndDate()	@deprecated. Please use the ’endDate’ property instead. Gets or sets the end value of the grouping range.
setEndDate(Date)	@deprecated. Please use the ’endDate’ property instead. Gets or sets the end value of the grouping range.
getInterval()	@deprecated. Please use the ‘interval’ property instead. Gets or sets the interval size for each group.
setInterval(number)	@deprecated. Please use the ‘interval’ property instead. Gets or sets the interval size for each group.
getGroupType()	@deprecated. Please use the ‘groupType’ property instead. Gets or sets the grouping type for pivot field. Only for grouping date time pivot field.
setGroupType(PivotGroupByType)	@deprecated. Please use the ‘groupType’ property instead. Gets or sets the grouping type for pivot field. Only for grouping date time pivot field.
getGroupTypes()	@deprecated. Please use the ‘groupTypes’ property instead. Gets or sets the grouping type for pivot field.
setGroupTypes(PivotGroupByType[])	@deprecated. Please use the ‘groupTypes’ property instead. Gets or sets the grouping type for pivot field.
getNewPivotField()	@deprecated. Please use the ’newPivotField’ property instead. Gets or sets a value indicating whether new pivot fields should be created after grouping.
setNewPivotField(boolean)	@deprecated. Please use the ’newPivotField’ property instead. Gets or sets a value indicating whether new pivot fields should be created after grouping.
isNull()	Checks whether the implementation object is null.

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.

isAutoStart()

@deprecated. Please use the ‘isAutoStart’ property instead. 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.

setIsAutoStart(boolean)

@deprecated. Please use the ‘isAutoStart’ property instead. Gets or sets a value indicating whether the start value is automatically determined.

setIsAutoStart(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

If StartNumber or StartDate is set, this property will be false.

isAutoEnd()

@deprecated. Please use the ‘isAutoEnd’ property instead. 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.

setIsAutoEnd(boolean)

@deprecated. Please use the ‘isAutoEnd’ property instead. Gets or sets a value indicating whether the end value is automatically determined.

setIsAutoEnd(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

If EndNumber or EndDate is set, this property will be false.

getStartNumber()

@deprecated. Please use the ‘startNumber’ property instead. Gets or sets the start value of the grouping range.

getStartNumber() : number;

setStartNumber(number)

@deprecated. Please use the ‘startNumber’ property instead. Gets or sets the start value of the grouping range.

setStartNumber(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getEndNumber()

@deprecated. Please use the ’endNumber’ property instead. Gets or sets the end value of the grouping range.

getEndNumber() : number;

setEndNumber(number)

@deprecated. Please use the ’endNumber’ property instead. Gets or sets the end value of the grouping range.

setEndNumber(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getStartDate()

@deprecated. Please use the ‘startDate’ property instead. Gets or sets the start value of the grouping range.

getStartDate() : Date;

setStartDate(Date)

@deprecated. Please use the ‘startDate’ property instead. Gets or sets the start value of the grouping range.

setStartDate(value: Date) : void;

Parameters:

Parameter	Type	Description
value	Date	The value to set.

getEndDate()

@deprecated. Please use the ’endDate’ property instead. Gets or sets the end value of the grouping range.

getEndDate() : Date;

setEndDate(Date)

@deprecated. Please use the ’endDate’ property instead. Gets or sets the end value of the grouping range.

setEndDate(value: Date) : void;

Parameters:

Parameter	Type	Description
value	Date	The value to set.

getInterval()

@deprecated. Please use the ‘interval’ property instead. Gets or sets the interval size for each group.

getInterval() : number;

Remarks

Only for number and days group.

setInterval(number)

@deprecated. Please use the ‘interval’ property instead. Gets or sets the interval size for each group.

setInterval(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

Only for number and days group.

getGroupType()

@deprecated. Please use the ‘groupType’ property instead. Gets or sets the grouping type for pivot field. Only for grouping date time pivot field.

getGroupType() : PivotGroupByType;

Returns

PivotGroupByType

setGroupType(PivotGroupByType)

@deprecated. Please use the ‘groupType’ property instead. Gets or sets the grouping type for pivot field. Only for grouping date time pivot field.

setGroupType(value: PivotGroupByType) : void;

Parameters:

Parameter	Type	Description
value	PivotGroupByType	The value to set.

getGroupTypes()

@deprecated. Please use the ‘groupTypes’ property instead. Gets or sets the grouping type for pivot field.

getGroupTypes() : PivotGroupByType[];

Returns

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).

setGroupTypes(PivotGroupByType[])

@deprecated. Please use the ‘groupTypes’ property instead. Gets or sets the grouping type for pivot field.

setGroupTypes(value: PivotGroupByType[]) : void;

Parameters:

Parameter	Type	Description
value	PivotGroupByType[]	The value to set.

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).

getNewPivotField()

@deprecated. Please use the ’newPivotField’ property instead. Gets or sets a value indicating whether new pivot fields should be created after grouping.

getNewPivotField() : 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.

setNewPivotField(boolean)

@deprecated. Please use the ’newPivotField’ property instead. Gets or sets a value indicating whether new pivot fields should be created after grouping.

setNewPivotField(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;