API Reference
@univerjs
@univerjs/sheets
classes
Sheetinterceptorservice

@univerjs/sheets v0.1.17Docs


Class: SheetInterceptorService

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

It would inject Workbook & Worksheet.

Extends

Constructors

new SheetInterceptorService()

new SheetInterceptorService(_univerInstanceService): SheetInterceptorService

Parameters

ParameterType
_univerInstanceServiceIUniverInstanceService

Returns

SheetInterceptorService

Overrides

Disposable.constructor

Defined in

packages/sheets/src/services/sheet-interceptor/sheet-interceptor.service.ts:59 (opens in a new tab)

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseDisposable._disposedpackages/core/src/shared/lifecycle.ts:93 (opens in a new tab)

Methods

dispose()

dispose(): void

Returns

void

Overrides

Disposable.dispose

Defined in

packages/sheets/src/services/sheet-interceptor/sheet-interceptor.service.ts:86 (opens in a new tab)


disposeWithMe()

protected disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)


fetchThroughInterceptors()

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

Type Parameters

Type Parameter
T
C

Parameters

ParameterType
nameIInterceptor<T, C>

Returns

Function

Parameters
ParameterType
initValueNullable<T>
initContextC
Returns

Nullable<T>

Defined in

packages/sheets/src/services/sheet-interceptor/sheet-interceptor.service.ts:137 (opens in a new tab)


intercept()

intercept<T>(name, interceptor): IDisposable

Type Parameters

Type Parameter
T extends IInterceptor<any, any>

Parameters

ParameterType
nameT
interceptorT

Returns

IDisposable

Defined in

packages/sheets/src/services/sheet-interceptor/sheet-interceptor.service.ts:121 (opens in a new tab)


interceptCommand()

interceptCommand(interceptor): IDisposable

Parameters

ParameterType
interceptorICommandInterceptor

Returns

IDisposable

Defined in

packages/sheets/src/services/sheet-interceptor/sheet-interceptor.service.ts:94 (opens in a new tab)


onCommandExecute()

onCommandExecute(command): IUndoRedoCommandInfosByInterceptor

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

Parameters

ParameterType
commandICommandInfo<object>

Returns

IUndoRedoCommandInfosByInterceptor

Defined in

packages/sheets/src/services/sheet-interceptor/sheet-interceptor.service.ts:110 (opens in a new tab)


Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.