@univerjsengine-formulaindexclassesUniverformulaengineplugin

@univerjs/engine-formula v0.5.0-beta.1Docs


Class: UniverFormulaEnginePlugin

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

Extends

Extended by

Constructors

new UniverFormulaEnginePlugin()

new UniverFormulaEnginePlugin(
   _config, 
   _injector, 
   _configService): UniverFormulaEnginePlugin

Parameters

ParameterTypeDefault value
_configPartial<IUniverEngineFormulaConfig>defaultPluginConfig
_injectorInjectorundefined
_configServiceIConfigServiceundefined

Returns

UniverFormulaEnginePlugin

Overrides

Plugin.constructor

Defined in

submodules/univer/packages/engine-formula/src/plugin.ts:63

Properties

PropertyModifierTypeDefault valueOverridesInherited fromDefined in
_configreadonlyPartial<IUniverEngineFormulaConfig>defaultPluginConfig--submodules/univer/packages/engine-formula/src/plugin.ts:64
_configServicereadonlyIConfigServiceundefined--submodules/univer/packages/engine-formula/src/plugin.ts:66
_disposedprotectedbooleanfalse-Plugin._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:93
_injectorprotectedInjectorundefined-Plugin._injectorsubmodules/univer/packages/engine-formula/src/plugin.ts:65
pluginNamestaticstringPLUGIN_NAMEPlugin.pluginName-submodules/univer/packages/engine-formula/src/plugin.ts:61
typestaticUniverInstanceTypeUniverInstanceType.UNIVER_UNKNOWN-Plugin.typesubmodules/univer/packages/core/src/services/plugin/plugin.ts:35

Methods

_initializeWithOverride()

protected _initializeWithOverride(): void

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/plugin.ts:166


dispose()

dispose(): void

Returns

void

Inherited from

Plugin.dispose

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:106


disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Plugin.disposeWithMe

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:96


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Plugin.ensureNotDisposed

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:100


getPluginName()

getPluginName(): string

Returns

string

Inherited from

Plugin.getPluginName

Defined in

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


getUniverInstanceType()

getUniverInstanceType(): UniverInstanceType

Returns

UniverInstanceType

Inherited from

Plugin.getUniverInstanceType

Defined in

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


onReady()

onReady(): void

Returns

void

Overrides

Plugin.onReady

Defined in

submodules/univer/packages/engine-formula/src/plugin.ts:80


onRendered()

onRendered(): void

Returns

void

Overrides

Plugin.onRendered

Defined in

submodules/univer/packages/engine-formula/src/plugin.ts:97


onStarting()

onStarting(): void

Returns

void

Overrides

Plugin.onStarting

Defined in

submodules/univer/packages/engine-formula/src/plugin.ts:75


onSteady()

onSteady(): void

Returns

void

Inherited from

Plugin.onSteady

Defined in

submodules/univer/packages/core/src/services/plugin/plugin.ts:51