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

Class: UniverProFormulaEnginePlugin

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

Extends

UniverFormulaEnginePlugin

Constructors

new UniverProFormulaEnginePlugin()

new UniverProFormulaEnginePlugin(
   _config, 
   _injector, 
   _configService): UniverProFormulaEnginePlugin

Parameters

Parameter	Type	Default value
`_config`	`Partial`<`IUniverEngineFormulaConfig`>	`defaultPluginConfig`
`_injector`	`Injector`	`undefined`
`_configService`	`IConfigService`	`undefined`

Returns

UniverProFormulaEnginePlugin

Inherited from

UniverFormulaEnginePlugin.constructor

Defined in

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

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_config`	`readonly`	`Partial`<`IUniverEngineFormulaConfig`>	`defaultPluginConfig`	`UniverFormulaEnginePlugin`.`_config`	submodules/univer/packages/engine-formula/src/plugin.ts:64
`_configService`	`readonly`	`IConfigService`	`undefined`	`UniverFormulaEnginePlugin`.`_configService`	submodules/univer/packages/engine-formula/src/plugin.ts:66
`_disposed`	`protected`	`boolean`	`false`	`UniverFormulaEnginePlugin`.`_disposed`	submodules/univer/packages/core/src/shared/lifecycle.ts:93
`_injector`	`protected`	`Injector`	`undefined`	`UniverFormulaEnginePlugin`.`_injector`	submodules/univer/packages/engine-formula/src/plugin.ts:65
`pluginName`	`static`	`string`	`PLUGIN_NAME`	`UniverFormulaEnginePlugin`.`pluginName`	submodules/univer/packages/engine-formula/src/plugin.ts:61
`type`	`static`	`UniverInstanceType`	`UniverInstanceType.UNIVER_UNKNOWN`	`UniverFormulaEnginePlugin`.`type`	submodules/univer/packages/core/src/services/plugin/plugin.ts:35

Methods

_initializeWithOverride()

protected _initializeWithOverride(): void

Returns

void

Overrides

UniverFormulaEnginePlugin._initializeWithOverride

Defined in

packages/engine-formula/src/plugin.ts:12

dispose()

dispose(): void

Returns

void

Inherited from

UniverFormulaEnginePlugin.dispose

Defined in

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

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

UniverFormulaEnginePlugin.disposeWithMe

Defined in

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

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

UniverFormulaEnginePlugin.ensureNotDisposed

Defined in

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

getPluginName()

getPluginName(): string

Returns

string

Inherited from

UniverFormulaEnginePlugin.getPluginName

Defined in

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

getUniverInstanceType()

getUniverInstanceType(): UniverInstanceType

Returns

UniverInstanceType

Inherited from

UniverFormulaEnginePlugin.getUniverInstanceType

Defined in

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

onReady()

onReady(): void

Returns

void

Inherited from

UniverFormulaEnginePlugin.onReady

Defined in

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

onRendered()

onRendered(): void

Returns

void

Inherited from

UniverFormulaEnginePlugin.onRendered

Defined in

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

onStarting()

onStarting(): void

Returns

void

Inherited from

UniverFormulaEnginePlugin.onStarting

Defined in

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

onSteady()

onSteady(): void

Returns

void

Inherited from

UniverFormulaEnginePlugin.onSteady

Defined in

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

Readme Readme