@univerjssheets-filterindexclassesUniversheetsfilterplugin

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


Class: UniverSheetsFilterPlugin

Plug-in base class, all plug-ins must inherit from this base class. Provide basic methods.

Extends

Constructors

new UniverSheetsFilterPlugin()

new UniverSheetsFilterPlugin(
   _config, 
   _injector, 
   _configService): UniverSheetsFilterPlugin

Parameters

ParameterTypeDefault value
_configPartial<IUniverSheetsFilterConfig>defaultPluginConfig
_injectorInjectorundefined
_configServiceIConfigServiceundefined

Returns

UniverSheetsFilterPlugin

Overrides

Plugin.constructor

Defined in

sheets-filter/src/plugin.ts:29

Properties

PropertyModifierTypeDefault valueOverridesInherited fromDefined in
_disposedprotectedbooleanfalse-Plugin._disposedcore/src/shared/lifecycle.ts:93
_injectorreadonlyInjectorundefined-Plugin._injectorsheets-filter/src/plugin.ts:31
pluginNamestaticstringSHEET_FILTER_SNAPSHOT_IDPlugin.pluginName-sheets-filter/src/plugin.ts:27
typestaticUniverInstanceTypeUniverInstanceType.UNIVER_SHEETPlugin.type-sheets-filter/src/plugin.ts:26

Methods

dispose()

dispose(): void

Returns

void

Inherited from

Plugin.dispose

Defined in

core/src/shared/lifecycle.ts:106


disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Plugin.disposeWithMe

Defined in

core/src/shared/lifecycle.ts:96


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Plugin.ensureNotDisposed

Defined in

core/src/shared/lifecycle.ts:100


getPluginName()

getPluginName(): string

Returns

string

Inherited from

Plugin.getPluginName

Defined in

core/src/services/plugin/plugin.ts:59


getUniverInstanceType()

getUniverInstanceType(): UniverInstanceType

Returns

UniverInstanceType

Inherited from

Plugin.getUniverInstanceType

Defined in

core/src/services/plugin/plugin.ts:55


onReady()

onReady(): void

Returns

void

Overrides

Plugin.onReady

Defined in

sheets-filter/src/plugin.ts:48


onRendered()

onRendered(): void

Returns

void

Inherited from

Plugin.onRendered

Defined in

core/src/services/plugin/plugin.ts:47


onStarting()

onStarting(): void

Returns

void

Overrides

Plugin.onStarting

Defined in

sheets-filter/src/plugin.ts:41


onSteady()

onSteady(): void

Returns

void

Inherited from

Plugin.onSteady

Defined in

core/src/services/plugin/plugin.ts:51