API Reference
@univerjs
@univerjs/core
classes
Plugin

@univerjs/core v0.1.17Docs


Class: abstract Plugin

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

Extends

Extended by

Constructors

new Plugin()

new Plugin(): Plugin

Returns

Plugin

Inherited from

Disposable.constructor

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseDisposable._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
_injectorabstractInjectorundefined-submodules/univer/packages/core/src/services/plugin/plugin.ts:37 (opens in a new tab)
pluginNamestaticstringundefined-submodules/univer/packages/core/src/services/plugin/plugin.ts:33 (opens in a new tab)
typestaticUniverInstanceTypeUniverInstanceType.UNIVER_UNKNOWN-submodules/univer/packages/core/src/services/plugin/plugin.ts:35 (opens in a new tab)

Methods

dispose()

dispose(): void

Returns

void

Inherited from

Disposable.dispose

Defined in

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


disposeWithMe()

protected disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

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


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

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


getPluginName()

getPluginName(): string

Returns

string

Defined in

submodules/univer/packages/core/src/services/plugin/plugin.ts:60 (opens in a new tab)


getUniverInstanceType()

getUniverInstanceType(): UniverInstanceType

Returns

UniverInstanceType

Defined in

submodules/univer/packages/core/src/services/plugin/plugin.ts:56 (opens in a new tab)


onReady()

onReady(): void

Returns

void

Defined in

submodules/univer/packages/core/src/services/plugin/plugin.ts:44 (opens in a new tab)


onRendered()

onRendered(): void

Returns

void

Defined in

submodules/univer/packages/core/src/services/plugin/plugin.ts:48 (opens in a new tab)


onStarting()

onStarting(injector): void

Parameters

ParameterType
injectorInjector

Returns

void

Defined in

submodules/univer/packages/core/src/services/plugin/plugin.ts:40 (opens in a new tab)


onSteady()

onSteady(): void

Returns

void

Defined in

submodules/univer/packages/core/src/services/plugin/plugin.ts:52 (opens in a new tab)


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