@univerjs-prosheets-pivotindexclassesSheetspivottableadaptormodel

@univerjs-pro/sheets-pivot v0.5.4


Class: SheetsPivotTableAdaptorModel

Defined in: packages/sheets-pivot/src/models/sheets-pivot-table-adaptor-model.ts:11

Extends

Constructors

new SheetsPivotTableAdaptorModel()

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

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

Parameters

ParameterType
_localeServiceLocaleService
_injectorInjector
_sheetsPivotTableConfigModelSheetsPivotTableConfigModel
_univerInstanceServiceIUniverInstanceService
_exclusiveRangeServiceIExclusiveRangeService

Returns

SheetsPivotTableAdaptorModel

Overrides

Disposable.constructor

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseDisposable._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:96
markDirty$publicObservable<{ subUnitId: string; unitId: string; }>undefined-packages/sheets-pivot/src/models/sheets-pivot-table-adaptor-model.ts:17
viewUpdate$publicObservable<IPivotViewUpdateInfo>undefined-packages/sheets-pivot/src/models/sheets-pivot-table-adaptor-model.ts:20

Methods

clearRenderCache()

clearRenderCache(config): void

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

Parameters

ParameterType
configIPivotTableConfigChangeInfo

Returns

void


deleteUnitId()

deleteUnitId(unitId): void

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

Parameters

ParameterType
unitIdstring

Returns

void


dispose()

dispose(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:109

Returns

void

Inherited from

Disposable.dispose


disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:99

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe


ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

Disposable.ensureNotDisposed


getIntersectsPivotTable()

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

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

Get pivot table ids that intersect with the range

Parameters

ParameterTypeDescription
unitIdstringThe test unit id of range
subUnitIdstringThe sub unit id of range
rangeIRangeThe range to check

Returns

string[]

The pivot table ids that intersect with the range


getPivotItemRenderInfoCache()

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

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

Parameters

ParameterType
unitIdstring
subUnitIdstring
pivotTableIdstring

Returns

Nullable<IPivotRenderCache>


getPivotTableCellData()

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

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

Parameters

ParameterType
unitIdstring
subUnitIdstring
rownumber
colnumber

Returns

| undefined | IPivotTableCellData


getPivotTableIdByCell()

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

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

Parameters

ParameterType
unitIdstring
subUnitIdstring
rownumber
colnumber

Returns

Nullable<string>


getSubUnitPivotMatrix()

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

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

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

ObjectMatrix<Nullable<IPivotTableCellData>>


markDirty()

markDirty(unitId, subUnitId): void

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

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

void


updateRenderCache()

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

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

Parameters

ParameterType
configIPivotTableConfigChangeInfo

Returns

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