@univerjsuniscriptclassesUniveruniscriptplugin

@univerjs/uniscript v0.5.4


Class: UniverUniscriptPlugin

Defined in: submodules/univer/packages/uniscript/src/plugin.ts:28

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

Extends

Constructors

new UniverUniscriptPlugin()

new UniverUniscriptPlugin(
   _config, 
   _injector, 
   _configService): UniverUniscriptPlugin

Defined in: submodules/univer/packages/uniscript/src/plugin.ts:31

Parameters

ParameterTypeDefault value
_configPartial<IUniverUniscriptConfig>defaultPluginConfig
_injectorInjectorundefined
_configServiceIConfigServiceundefined

Returns

UniverUniscriptPlugin

Overrides

Plugin.constructor

Properties

PropertyModifierTypeDefault valueOverridesInherited fromDefined in
_disposedprotectedbooleanfalse-Plugin._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:96
_injectorprotectedInjectorundefined-Plugin._injectorsubmodules/univer/packages/uniscript/src/plugin.ts:33
pluginNamestaticstringPLUGIN_NAMEPlugin.pluginName-submodules/univer/packages/uniscript/src/plugin.ts:29
typestaticUniverInstanceTypeUniverInstanceType.UNIVER_UNKNOWN-Plugin.typesubmodules/univer/packages/core/src/services/plugin/plugin.ts:35

Methods

dispose()

dispose(): void

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

Returns

void

Inherited from

Plugin.dispose


disposeWithMe()

disposeWithMe(disposable): IDisposable

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

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Plugin.disposeWithMe


ensureNotDisposed()

protected ensureNotDisposed(): void

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

Returns

void

Inherited from

Plugin.ensureNotDisposed


getPluginName()

getPluginName(): string

Defined in: submodules/univer/packages/core/src/services/plugin/plugin.ts:59

Returns

string

Inherited from

Plugin.getPluginName


getUniverInstanceType()

getUniverInstanceType(): UniverInstanceType

Defined in: submodules/univer/packages/core/src/services/plugin/plugin.ts:55

Returns

UniverInstanceType

Inherited from

Plugin.getUniverInstanceType


onReady()

onReady(): void

Defined in: submodules/univer/packages/core/src/services/plugin/plugin.ts:43

Returns

void

Inherited from

Plugin.onReady


onRendered()

onRendered(): void

Defined in: submodules/univer/packages/core/src/services/plugin/plugin.ts:47

Returns

void

Inherited from

Plugin.onRendered


onStarting()

onStarting(): void

Defined in: submodules/univer/packages/uniscript/src/plugin.ts:50

Returns

void

Overrides

Plugin.onStarting


onSteady()

onSteady(): void

Defined in: submodules/univer/packages/uniscript/src/plugin.ts:63

Returns

void

Overrides

Plugin.onSteady


registerExecution()

registerExecution(): void

Defined in: submodules/univer/packages/uniscript/src/plugin.ts:70

Allows being overridden, replacing with a new UniscriptExecutionService.

Returns

void