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

Class: SheetInterceptorService

This class expose methods for sheet features to inject code to sheet underlying logic.

Extends

Disposable

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
`writeCellInterceptor`	`readonly`	`InterceptorManager`<{ `AFTER_CELL_EDIT`: `IInterceptor`<`ICellDataForSheetInterceptor`, `ISheetLocationForEditor`>; `AFTER_CELL_EDIT_ASYNC`: `IInterceptor`<`Promise`<`Nullable`<`ICellDataForSheetInterceptor`>>, `ISheetLocationForEditor`>; `BEFORE_CELL_EDIT`: `IInterceptor`<`ICellDataForSheetInterceptor`, `ISheetLocationForEditor`>; }>	`undefined`	-	submodules/univer/packages/sheets/src/services/sheet-interceptor/sheet-interceptor.service.ts:89

Methods

beforeCommandExecute()

beforeCommandExecute(info): Promise<boolean>

before command execute, call this method to get the flag of whether it can be executed the command，

Parameters

Parameter	Type	Description
`info`	`ICommandInfo`<`object`>	ICommandInfo

Returns

Promise<boolean>

Promise

Defined in

submodules/univer/packages/sheets/src/services/sheet-interceptor/sheet-interceptor.service.ts:211

dispose()

dispose(): void

Returns

void

Overrides

Disposable.dispose

Defined in

submodules/univer/packages/sheets/src/services/sheet-interceptor/sheet-interceptor.service.ts:141

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

fetchThroughInterceptors()

fetchThroughInterceptors<T, C>(name, effect?): (initValue, initContext) => Nullable<T>

Type Parameters

Type Parameter
`T`
`C`

Parameters

Parameter	Type
`name`	`IInterceptor`<`T`, `C`>
`effect`?	`InterceptorEffectEnum`

Returns

Function

Parameters

Parameter	Type
`initValue`	`Nullable`<`T`>
`initContext`	`C`

Returns

Nullable<T>

Defined in

submodules/univer/packages/sheets/src/services/sheet-interceptor/sheet-interceptor.service.ts:302

generateMutationsByRanges()

generateMutationsByRanges(info): IUndoRedoCommandInfosByInterceptor

Parameters

Parameter	Type
`info`	`IRangesInfo`

Returns

IUndoRedoCommandInfosByInterceptor

Defined in

submodules/univer/packages/sheets/src/services/sheet-interceptor/sheet-interceptor.service.ts:236

intercept()

intercept<T>(name, interceptor): IDisposable

Type Parameters

Type Parameter
`T` extends `IInterceptor`<`any`, `any`>

Parameters

Parameter	Type
`name`	`T`
`interceptor`	`T`

Returns

IDisposable

Defined in

submodules/univer/packages/sheets/src/services/sheet-interceptor/sheet-interceptor.service.ts:269

interceptBeforeCommand()

interceptBeforeCommand(interceptor): IDisposable

Add a listener function to a specific command to deteminte if the command can execute mutations. It should be called in controllers.

Pairs with beforeCommandExecute.

Parameters

Parameter	Type
`interceptor`	`IBeforeCommandInterceptor`

Returns

IDisposable

Defined in

submodules/univer/packages/sheets/src/services/sheet-interceptor/sheet-interceptor.service.ts:195

interceptCommand()

interceptCommand(interceptor): IDisposable

Add a listener function to a specific command to add affiliated mutations. It should be called in controllers.

Pairs with onCommandExecute.

Parameters

Parameter	Type
`interceptor`	`ICommandInterceptor`

Returns

IDisposable

Defined in

submodules/univer/packages/sheets/src/services/sheet-interceptor/sheet-interceptor.service.ts:159

interceptRanges()

interceptRanges(interceptor): IDisposable

By adding callbacks to some Ranges can get some additional mutations, such as clearing all plugin data in a certain area.

Parameters

Parameter	Type	Description
`interceptor`	`IRangeInterceptors`	IRangeInterceptors

Returns

IDisposable

IDisposable

Defined in

submodules/univer/packages/sheets/src/services/sheet-interceptor/sheet-interceptor.service.ts:225

onCommandExecute()

onCommandExecute(info): IUndoRedoCommandInfosByInterceptor

When command is executing, call this method to gether undo redo mutations from upper features.

Parameters

Parameter	Type
`info`	`ICommandInfo`<`object`>

Returns

IUndoRedoCommandInfosByInterceptor

Defined in

submodules/univer/packages/sheets/src/services/sheet-interceptor/sheet-interceptor.service.ts:175

onWriteCell()

onWriteCell(
   workbook, 
   worksheet, 
   row, 
   col, 
cellData): Promise<Nullable<ICellDataForSheetInterceptor>>

Parameters

Parameter	Type
`workbook`	`Workbook`
`worksheet`	`Worksheet`
`row`	`number`
`col`	`number`
`cellData`	`ICellData`

Returns

Promise<Nullable<ICellDataForSheetInterceptor>>

Defined in

submodules/univer/packages/sheets/src/services/sheet-interceptor/sheet-interceptor.service.ts:249

Refselectionsservice Sheetsselectionsservice