API Reference
@univerjs
@univerjs/docs
classes
Univerdocsplugin

@univerjs/docs v0.1.17Docs


Class: UniverDocsPlugin

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

Extends

Constructors

new UniverDocsPlugin()

new UniverDocsPlugin(_config, _injector): UniverDocsPlugin

Parameters

ParameterType
_configPartial<IUniverDocsConfig>
_injectorInjector

Returns

UniverDocsPlugin

Overrides

Plugin.constructor

Defined in

docs/src/doc-plugin.ts:70 (opens in a new tab)

Properties

PropertyModifierTypeDefault valueOverridesInherited fromDefined in
_disposedprotectedbooleanfalse-Plugin._disposedcore/src/shared/lifecycle.ts:93 (opens in a new tab)
_injectorpublicInjectorundefined-Plugin._injectordocs/src/doc-plugin.ts:72 (opens in a new tab)
pluginNamestaticstringPLUGIN_NAMEPlugin.pluginName-docs/src/doc-plugin.ts:67 (opens in a new tab)
typestaticUniverInstanceTypeUniverInstanceType.UNIVER_DOCPlugin.type-docs/src/doc-plugin.ts:68 (opens in a new tab)

Methods

dispose()

dispose(): void

Returns

void

Inherited from

Plugin.dispose

Defined in

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


disposeWithMe()

protected disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Plugin.disposeWithMe

Defined in

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


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Plugin.ensureNotDisposed

Defined in

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


getPluginName()

getPluginName(): string

Returns

string

Inherited from

Plugin.getPluginName

Defined in

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


getUniverInstanceType()

getUniverInstanceType(): UniverInstanceType

Returns

UniverInstanceType

Inherited from

Plugin.getUniverInstanceType

Defined in

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


onReady()

onReady(): void

Returns

void

Inherited from

Plugin.onReady

Defined in

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


onRendered()

onRendered(): void

Returns

void

Inherited from

Plugin.onRendered

Defined in

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


onStarting()

onStarting(injector): void

Parameters

ParameterType
injectorInjector

Returns

void

Inherited from

Plugin.onStarting

Defined in

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


onSteady()

onSteady(): void

Returns

void

Inherited from

Plugin.onSteady

Defined in

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


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