API Reference
@univerjs
@univerjs/engine-render
classes
Univerrenderengineplugin

@univerjs/engine-render v0.4.2Docs


Class: UniverRenderEnginePlugin

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

Extends

Constructors

new UniverRenderEnginePlugin()

new UniverRenderEnginePlugin(
   _config, 
   _injector, 
   _configService): UniverRenderEnginePlugin

Parameters

ParameterTypeDefault value
_configPartial<IUniverEngineRenderConfig>defaultPluginConfig
_injectorInjectorundefined
_configServiceIConfigServiceundefined

Returns

UniverRenderEnginePlugin

Overrides

Plugin.constructor

Defined in

submodules/univer/packages/engine-render/src/plugin.ts:34 (opens in a new tab)

Properties

PropertyModifierTypeDefault valueOverridesInherited fromDefined in
_disposedprotectedbooleanfalse-Plugin._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
_injectorreadonlyInjectorundefined-Plugin._injectorsubmodules/univer/packages/engine-render/src/plugin.ts:36 (opens in a new tab)
pluginNamestaticstringPLUGIN_NAMEPlugin.pluginName-submodules/univer/packages/engine-render/src/plugin.ts:32 (opens in a new tab)
typestaticUniverInstanceTypeUniverInstanceType.UNIVER_UNKNOWN-Plugin.typesubmodules/univer/packages/core/src/services/plugin/plugin.ts:35 (opens in a new tab)

Methods

dispose()

dispose(): void

Returns

void

Inherited from

Plugin.dispose

Defined in

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


disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Plugin.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

Plugin.ensureNotDisposed

Defined in

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


getPluginName()

getPluginName(): string

Returns

string

Inherited from

Plugin.getPluginName

Defined in

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


getUniverInstanceType()

getUniverInstanceType(): UniverInstanceType

Returns

UniverInstanceType

Inherited from

Plugin.getUniverInstanceType

Defined in

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


onReady()

onReady(): void

Returns

void

Inherited from

Plugin.onReady

Defined in

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


onRendered()

onRendered(): void

Returns

void

Inherited from

Plugin.onRendered

Defined in

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


onStarting()

onStarting(): void

Returns

void

Inherited from

Plugin.onStarting

Defined in

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


onSteady()

onSteady(): void

Returns

void

Inherited from

Plugin.onSteady

Defined in

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


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