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

Class: SheetsPivotTableConfigModel

Extends

Disposable

Constructors

new SheetsPivotTableConfigModel()

new SheetsPivotTableConfigModel(
   _injector, 
   _commandService, 
   _univerInstanceService): SheetsPivotTableConfigModel

Parameters

Parameter	Type
`_injector`	`Injector`
`_commandService`	`ICommandService`
`_univerInstanceService`	`IUniverInstanceService`

Returns

SheetsPivotTableConfigModel

Overrides

Disposable.constructor

Defined in

packages/sheets-pivot/src/models/sheets-pivot-config-model.ts:36

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`Disposable`.`_disposed`	submodules/univer/packages/core/src/shared/lifecycle.ts:93
`configVersion$`	`public`	`Observable`<`number`>	`undefined`	-	packages/sheets-pivot/src/models/sheets-pivot-config-model.ts:34
`pivotConfigChange$`	`public`	`Observable`<{ `pivotTableConfig`: `Nullable`<`IPivotTableConfig`>; `pivotTableId`: `string`; `subUnitId`: `string`; `unitId`: `string`; }>	`undefined`	-	packages/sheets-pivot/src/models/sheets-pivot-config-model.ts:31
`pivotInitCompleted$`	`public`	`Observable`<`boolean`>	`undefined`	-	packages/sheets-pivot/src/models/sheets-pivot-config-model.ts:22

Methods

deleteUnitId()

deleteUnitId(unitId): void

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

Defined in

packages/sheets-pivot/src/models/sheets-pivot-config-model.ts:207

dispose()

dispose(): void

Returns

void

Inherited from

Disposable.dispose

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:106

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:96

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:100

getCollection()

getCollection(unitId, pivotTableId): undefined | IFieldsCollectionJSON

Parameters

Parameter	Type
`unitId`	`string`
`pivotTableId`	`string`

Returns

undefined | IFieldsCollectionJSON

Defined in

packages/sheets-pivot/src/models/sheets-pivot-config-model.ts:110

getPivotTableConfig()

getPivotTableConfig(
   unitId, 
   subUnitId, 
pivotTableId): Nullable<IPivotTableConfig>

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`pivotTableId`	`string`

Returns

Nullable<IPivotTableConfig>

Defined in

packages/sheets-pivot/src/models/sheets-pivot-config-model.ts:77

getPivotTableMatrixInfo()

getPivotTableMatrixInfo(
   unitId, 
   subUnitId, 
   pivotTableId): undefined | IPivotTableMatrixInfo

get the pivot table matrix info for sheet or calc engine

Parameters

Parameter	Type	Description
`unitId`	`string`	the unit id
`subUnitId`	`string`	the sub unit id
`pivotTableId`	`string`	the pivot table id

Returns

undefined | IPivotTableMatrixInfo

the pivot table matrix info

Defined in

packages/sheets-pivot/src/models/sheets-pivot-config-model.ts:203

getPivotTableRangeInfo()

getPivotTableRangeInfo(
   unitId, 
   subUnitId, 
   pivotTableId): undefined | IPivotTableRangeInfo

get the pivot table range info for sheet or calc engine

Parameters

Parameter	Type	Description
`unitId`	`string`	the unit id
`subUnitId`	`string`	the sub unit id
`pivotTableId`	`string`	the pivot table id

Returns

undefined | IPivotTableRangeInfo

the pivot table range info

Defined in

packages/sheets-pivot/src/models/sheets-pivot-config-model.ts:192

getSubUnitPivotConfigs()

getSubUnitPivotConfigs(unitId, subUnitId): undefined | Map<string, IPivotTableConfig>

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`

Returns

undefined | Map<string, IPivotTableConfig>

Defined in

packages/sheets-pivot/src/models/sheets-pivot-config-model.ts:90

getTargetByPivotId()

getTargetByPivotId(
   unitId, 
   subUnitId, 
pivotTableId): Nullable<IPivotCellPositionInfo>

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`pivotTableId`	`string`

Returns

Nullable<IPivotCellPositionInfo>

Defined in

packages/sheets-pivot/src/models/sheets-pivot-config-model.ts:85

getTextInfo()

getTextInfo(): Record<string, string>

Returns

Record<string, string>

Defined in

packages/sheets-pivot/src/models/sheets-pivot-config-model.ts:68

setPivotInitCompleted()

setPivotInitCompleted(): void

Returns

void

Defined in

packages/sheets-pivot/src/models/sheets-pivot-config-model.ts:54

updateCollectionConfig()

updateCollectionConfig(unitId, collectionConfig): void

Parameters

Parameter	Type
`unitId`	`string`
`collectionConfig`	`IDataFieldManagerJSON`

Returns

void

Defined in

packages/sheets-pivot/src/models/sheets-pivot-config-model.ts:114

updateConfigCache()

updateConfigCache(
   unitId, 
   subUnitId, 
   pivotTableId, 
   pivotTableConfig): void

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`pivotTableId`	`string`
`pivotTableConfig`	`Nullable`<`IPivotTableConfig`>

Returns

void

Defined in

packages/sheets-pivot/src/models/sheets-pivot-config-model.ts:94

updatePivotTableMatrixInfo()

updatePivotTableMatrixInfo(
   unitId, 
   subUnitId, 
   pivotTableId, 
   matrixInfo): void

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`pivotTableId`	`string`
`matrixInfo`	`ObjectMatrix`<`Nullable`<`IPivotTableCellData`>>

Returns

void

Defined in

packages/sheets-pivot/src/models/sheets-pivot-config-model.ts:174

updatePivotTableRangeInfo()

updatePivotTableRangeInfo(
   unitId, 
   subUnitId, 
   pivotTableId, 
   rangeInfo): void

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`pivotTableId`	`string`
`rangeInfo`	`undefined` \| `IPivotRangesInfo`

Returns

void

Defined in

packages/sheets-pivot/src/models/sheets-pivot-config-model.ts:164

updateViewInfo()

updateViewInfo(
   unitId, 
   subUnitId, 
   pivotTableId, 
   valueMatrix, 
   rangesCache): void

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`pivotTableId`	`string`
`valueMatrix`	`ObjectMatrix`<`Nullable`<`IPivotTableCellData`>>
`rangesCache`	`undefined` \| `IPivotRangesInfo`

Returns

void

Defined in

packages/sheets-pivot/src/models/sheets-pivot-config-model.ts:72

Sheetspivottableadaptormodel Sheetspivottableservice