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

Class: SummaryManager

Constructors

new SummaryManager()

new SummaryManager(queryData, tupleGroup): SummaryManager

Parameters

Parameter	Type
`queryData`	`IPivotTableQueryData`
`tupleGroup`	`TupleGroup`

Returns

SummaryManager

Defined in

summary/summary-manager.ts:57

Properties

Property	Type	Default value	Description	Defined in
`_colLevelPool`	`IPivotSummaryLevelPool`	`{}`	-	summary/summary-manager.ts:45
`_rowLevelPool`	`IPivotSummaryLevelPool`	`{}`	-	summary/summary-manager.ts:44
`colDeep`	`number`	`undefined`	-	summary/summary-manager.ts:17
`colDimOrder`	`number`[]	`undefined`	-	summary/summary-manager.ts:13
`collapseInfo`	`Record`<`string`, `boolean` \| `Record`<`string`, `boolean`>>	`undefined`	-	summary/summary-manager.ts:53
`colNodeTree`	`NodeTree`	`undefined`	-	summary/summary-manager.ts:47
`colTableIdList`	`string`[]	`undefined`	-	summary/summary-manager.ts:15
`combinePathMap`	`Record`<`string`, `Record`<`string`, `number`>>	`{}`	fist Record key is combinePathMap	summary/summary-manager.ts:52
`counter`	`number`	`undefined`	-	summary/summary-manager.ts:11
`dimensionIdList`	`string`[]	`[]`	-	summary/summary-manager.ts:33
`dimensionMap`	`Record`<`string`, `IDimensionMapItem`>	`{}`	-	summary/summary-manager.ts:48
`dimensionSortInfo`	`Record`<`string`, { `sortMap`: `Record`<`string`, `number`>; `type`: `PivotDataFieldSortOperatorEnum`; }>	`{}`	-	summary/summary-manager.ts:55
`dimensionTableIdList`	`string`[]	`[]`	-	summary/summary-manager.ts:37
`leafCount`	`number`	`undefined`	-	summary/summary-manager.ts:19
`measureCount`	`number`	`undefined`	-	summary/summary-manager.ts:18
`measureIdList`	`string`[]	`[]`	-	summary/summary-manager.ts:42
`measuresMap`	`Record`<`string`, `IMeasuresMapItem`>	`{}`	-	summary/summary-manager.ts:20
`rowDeep`	`number`	`undefined`	-	summary/summary-manager.ts:16
`rowDimOrder`	`number`[]	`undefined`	-	summary/summary-manager.ts:12
`rowNodeTree`	`NodeTree`	`undefined`	-	summary/summary-manager.ts:46
`rowTableIdList`	`string`[]	`undefined`	-	summary/summary-manager.ts:14
`tupleMap`	`Record`<`string`, `number`>	`{}`	-	summary/summary-manager.ts:29
`tuples`	`ITupleItem`[]	`[]`	-	summary/summary-manager.ts:25

Methods

_buildNodeTreeImp()

_buildNodeTreeImp(
   dimOrder, 
   tableIdList, 
   levelPool, 
   nodePathStr): NodeTree

Parameters

Parameter	Type
`dimOrder`	`number`[]
`tableIdList`	`string`[]
`levelPool`	`IPivotSummaryLevelPool`
`nodePathStr`	`string`

Returns

NodeTree

Defined in

summary/summary-manager.ts:184

_calculateSubtotalImp()

_calculateSubtotalImp(levelPool): void

Parameters

Parameter	Type
`levelPool`	`IPivotSummaryLevelPool`

Returns

void

Defined in

summary/summary-manager.ts:359

buildNodeTree()

buildNodeTree(): void

Returns

void

Defined in

summary/summary-manager.ts:160

calculateListSubtotal()

calculateListSubtotal(tupleItem, indexes): void

Parameters

Parameter	Type
`tupleItem`	`ITupleItem`
`indexes`	`number`[]

Returns

void

Defined in

summary/summary-manager.ts:270

calculateSubtotal()

calculateSubtotal(): void

Returns

void

Defined in

summary/summary-manager.ts:291

combinePathMapList()

combinePathMapList(colPathMapList, basePath): Record<string, number>

Parameters

Parameter	Type
`colPathMapList`	`Record`<`string`, `number`>[]
`basePath`	`string`

Returns

Record<string, number>

Defined in

summary/summary-manager.ts:239

createSummaryLabelSortedMap()

createSummaryLabelSortedMap(queryData): void

Parameters

Parameter	Type
`queryData`	`IPivotTableQueryData`

Returns

void

Defined in

summary/summary-manager.ts:118

createTuple()

createTuple(
   paths, 
   pathsStr?, 
   nodeIndex?): void

create tuple if not exist

Parameters

Parameter	Type	Description
`paths`	`string`[]	the path of tuple
`pathsStr`?	`string`	the joined path string of tuple
`nodeIndex`?	`number`	-

Returns

void

Defined in

summary/summary-manager.ts:335

createTupleWithoutCheck()

createTupleWithoutCheck(
   paths, 
   nodeIndex, 
   tupleKey): void

Parameters

Parameter	Type
`paths`	`string`[]
`nodeIndex`	`number`
`tupleKey`	`string`

Returns

void

Defined in

summary/summary-manager.ts:169

doSummary()

doSummary(): void

Returns

void

Defined in

summary/summary-manager.ts:151

ensureTupleItem()

ensureTupleItem(
   index, 
   paths, 
   tableIdList): void

Parameters

Parameter	Type
`index`	`number`
`paths`	`string`[]
`tableIdList`	`string`[]

Returns

void

Defined in

summary/summary-manager.ts:316

ensureTupleItemByString()

ensureTupleItemByString(index, pathString): void

Parameters

Parameter	Type
`index`	`number`
`pathString`	`string`

Returns

void

Defined in

summary/summary-manager.ts:323

getCellValue()

getCellValue(
   index, 
   id, 
   subtotal): undefined | number | {
  errorType: PivotErrorTypeEnum;
}

Parameters

Parameter	Type
`index`	`number`
`id`	`string`
`subtotal`	`PivotSubtotalTypeEnum`

Returns

undefined | number | { errorType: PivotErrorTypeEnum; }

Defined in

summary/summary-manager.ts:129

getPathKeyWithFiledId()

getPathKeyWithFiledId(paths, tableIdList): string

Parameters

Parameter	Type
`paths`	`string`[]
`tableIdList`	`string`[]

Returns

string

Defined in

summary/summary-manager.ts:307

getSortedMap()

getSortedMap(tableFieldId, dataField): Record<string, number>

Parameters

Parameter	Type
`tableFieldId`	`string`
`dataField`	`DataField`

Returns

Record<string, number>

Defined in

summary/summary-manager.ts:136

Pivotviewitem Pivotcellstyletypeenum