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

Class: SheetsPivotTableAdaptorModel

Extends

Disposable

Constructors

new SheetsPivotTableAdaptorModel()

new SheetsPivotTableAdaptorModel(
   _localeService, 
   _injector, 
   _sheetsPivotTableConfigModel, 
   _univerInstanceService, 
   _exclusiveRangeService): SheetsPivotTableAdaptorModel

Parameters

Parameter	Type
`_localeService`	`LocaleService`
`_injector`	`Injector`
`_sheetsPivotTableConfigModel`	`SheetsPivotTableConfigModel`
`_univerInstanceService`	`IUniverInstanceService`
`_exclusiveRangeService`	`IExclusiveRangeService`

Returns

SheetsPivotTableAdaptorModel

Overrides

Disposable.constructor

Defined in

packages/sheets-pivot/src/models/sheets-pivot-table-adaptor-model.ts:24

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
`markDirty$`	`public`	`Observable`<{ `subUnitId`: `string`; `unitId`: `string`; }>	`undefined`	-	packages/sheets-pivot/src/models/sheets-pivot-table-adaptor-model.ts:17
`viewUpdate$`	`public`	`Observable`<{ `pivotTableId`: `string`; `rangesCache`: `undefined` \| `IPivotRangesInfo`; `subUnitId`: `string`; `type`: `PivotTableOperationEnum`; `unitId`: `string`; `valueMatrix`: `ObjectMatrix`<`Nullable`<`IPivotTableCellData`>>; }>	`undefined`	-	packages/sheets-pivot/src/models/sheets-pivot-table-adaptor-model.ts:20

Methods

clearRenderCache()

clearRenderCache(config): void

Parameters

Parameter	Type
`config`	`IPivotTableConfigChangeInfo`

Returns

void

Defined in

packages/sheets-pivot/src/models/sheets-pivot-table-adaptor-model.ts:148

deleteUnitId()

deleteUnitId(unitId): void

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

Defined in

packages/sheets-pivot/src/models/sheets-pivot-table-adaptor-model.ts:267

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

getIntersectsPivotTable()

getIntersectsPivotTable(
   unitId, 
   subUnitId, 
   range): string[]

Get pivot table ids that intersect with the range

Parameters

Parameter	Type	Description
`unitId`	`string`	The test unit id of range
`subUnitId`	`string`	The sub unit id of range
`range`	`IRange`	The range to check

Returns

string[]

The pivot table ids that intersect with the range

Defined in

packages/sheets-pivot/src/models/sheets-pivot-table-adaptor-model.ts:230

getPivotItemRenderInfoCache()

getPivotItemRenderInfoCache(
   unitId, 
   subUnitId, 
pivotTableId): Nullable<IPivotRenderCache>

Parameters

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

Returns

Nullable<IPivotRenderCache>

Defined in

packages/sheets-pivot/src/models/sheets-pivot-table-adaptor-model.ts:263

getPivotTableCellData()

getPivotTableCellData(
   unitId, 
   subUnitId, 
   row, 
   col): undefined | IPivotTableCellData

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`row`	`number`
`col`	`number`

Returns

undefined | IPivotTableCellData

Defined in

packages/sheets-pivot/src/models/sheets-pivot-table-adaptor-model.ts:197

getPivotTableIdByCell()

getPivotTableIdByCell(
   unitId, 
   subUnitId, 
   row, 
col): Nullable<string>

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`row`	`number`
`col`	`number`

Returns

Nullable<string>

Defined in

packages/sheets-pivot/src/models/sheets-pivot-table-adaptor-model.ts:205

getSubUnitPivotMatrix()

getSubUnitPivotMatrix(unitId, subUnitId): ObjectMatrix<Nullable<IPivotTableCellData>>

Parameters

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

Returns

ObjectMatrix<Nullable<IPivotTableCellData>>

Defined in

packages/sheets-pivot/src/models/sheets-pivot-table-adaptor-model.ts:259

markDirty()

markDirty(unitId, subUnitId): void

Parameters

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

Returns

void

Defined in

packages/sheets-pivot/src/models/sheets-pivot-table-adaptor-model.ts:272

updateRenderCache()

updateRenderCache(config): undefined | {
  matrix: ObjectMatrix<Nullable<IPivotTableCellData>>;
  rangeCache: undefined | IPivotRangesInfo;
}

Parameters

Parameter	Type
`config`	`IPivotTableConfigChangeInfo`

Returns

undefined | { matrix: ObjectMatrix<Nullable<IPivotTableCellData>>; rangeCache: undefined | IPivotRangesInfo; }

Defined in

packages/sheets-pivot/src/models/sheets-pivot-table-adaptor-model.ts:48

Sheetspivotrpcservice Sheetspivottableconfigmodel