@univerjs-pro/engine-pivot v0.5.0-beta.1 • Docs
Class: PivotTuple
PivotTuple
Description
use Welford algorithm calc subtotal https://en.wikipedia.org/wiki/Algorithms_for_calculating_variance
Constructors
new PivotTuple()
new PivotTuple(): PivotTuple
Returns
Defined in
summary/pivot-tuple.ts:21
Methods
addValue()
addValue(value): void
Parameters
Parameter | Type |
---|---|
value | IDataFieldValue |
Returns
void
Defined in
summary/pivot-tuple.ts:46
getInfo()
getInfo(): ITPivotTupleInfo
Returns
Defined in
summary/pivot-tuple.ts:24
getSubtotal()
getSubtotal(subtotalType): number | {
errorType: PivotErrorTypeEnum;
}
Parameters
Parameter | Type |
---|---|
subtotalType | PivotSubtotalTypeEnum |
Returns
number
| {
errorType
: PivotErrorTypeEnum
;
}
Defined in
summary/pivot-tuple.ts:81
reset()
reset(): void
Returns
void
Defined in
summary/pivot-tuple.ts:36
unionTupleInfo()
unionTupleInfo(tupleInfo): void
Parameters
Parameter | Type |
---|---|
tupleInfo | ITPivotTupleInfo |
Returns
void
Defined in
summary/pivot-tuple.ts:71
unionTuples()
unionTuples(tuples): void
Parameters
Parameter | Type |
---|---|
tuples | PivotTuple [] |
Returns
void
Defined in
summary/pivot-tuple.ts:59