@univerjs-pro/engine-pivot v0.5.0-beta.1Docs


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

PivotTuple

Defined in

summary/pivot-tuple.ts:21

Methods

addValue()

addValue(value): void

Parameters

ParameterType
valueIDataFieldValue

Returns

void

Defined in

summary/pivot-tuple.ts:46


getInfo()

getInfo(): ITPivotTupleInfo

Returns

ITPivotTupleInfo

Defined in

summary/pivot-tuple.ts:24


getSubtotal()

getSubtotal(subtotalType): number | {
  errorType: PivotErrorTypeEnum;
}

Parameters

ParameterType
subtotalTypePivotSubtotalTypeEnum

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

ParameterType
tupleInfoITPivotTupleInfo

Returns

void

Defined in

summary/pivot-tuple.ts:71


unionTuples()

unionTuples(tuples): void

Parameters

ParameterType
tuplesPivotTuple[]

Returns

void

Defined in

summary/pivot-tuple.ts:59