SubtotalSetting

SubtotalSetting class

Represents the setting of the subtotal .

class SubtotalSetting;

Properties

Property	Type	Description
groupBy	number	Readonly. The field to group by, as a zero-based integer offset
subtotalFunction	ConsolidationFunction	Readonly. The subtotal function.
totalList	number[]	Readonly. An array of zero-based field offsets, indicating the fields to which the subtotals are added.
summaryBelowData	boolean	Readonly. Indicates whether add summary below data.

Methods

Method	Description
getGroupBy()	@deprecated. Please use the ‘groupBy’ property instead. The field to group by, as a zero-based integer offset
getSubtotalFunction()	@deprecated. Please use the ‘subtotalFunction’ property instead. The subtotal function.
getTotalList()	@deprecated. Please use the ’totalList’ property instead. An array of zero-based field offsets, indicating the fields to which the subtotals are added.
getSummaryBelowData()	@deprecated. Please use the ‘summaryBelowData’ property instead. Indicates whether add summary below data.
isNull()	Checks whether the implementation object is null.

groupBy

Readonly. The field to group by, as a zero-based integer offset

groupBy : number;

subtotalFunction

Readonly. The subtotal function.

subtotalFunction : ConsolidationFunction;

totalList

Readonly. An array of zero-based field offsets, indicating the fields to which the subtotals are added.

totalList : number[];

summaryBelowData

Readonly. Indicates whether add summary below data.

summaryBelowData : boolean;

getGroupBy()

@deprecated. Please use the ‘groupBy’ property instead. The field to group by, as a zero-based integer offset

getGroupBy() : number;

getSubtotalFunction()

@deprecated. Please use the ‘subtotalFunction’ property instead. The subtotal function.

getSubtotalFunction() : ConsolidationFunction;

Returns

ConsolidationFunction

getTotalList()

@deprecated. Please use the ’totalList’ property instead. An array of zero-based field offsets, indicating the fields to which the subtotals are added.

getTotalList() : number[];

Returns

number[]

getSummaryBelowData()

@deprecated. Please use the ‘summaryBelowData’ property instead. Indicates whether add summary below data.

getSummaryBelowData() : boolean;

isNull()

Checks whether the implementation object is null.

isNull() : boolean;