@univerjs/uniscript v0.4.2 • Docs

Class: UniverUniscriptPlugin

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

Extends

Plugin

Constructors

new UniverUniscriptPlugin()

new UniverUniscriptPlugin(
   _config, 
   _injector, 
   _configService): UniverUniscriptPlugin

Parameters

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

Properties

Property	Modifier	Type	Default value	Overrides	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	-	`Plugin`.`_disposed`	packages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
`_injector`	`protected`	`Injector`	`undefined`	-	`Plugin`.`_injector`	packages/uniscript/src/plugin.ts:33 (opens in a new tab)
`pluginName`	`static`	`string`	`PLUGIN_NAME`	`Plugin`.`pluginName`	-	packages/uniscript/src/plugin.ts:29 (opens in a new tab)
`type`	`static`	`UniverInstanceType`	`UniverInstanceType.UNIVER_UNKNOWN`	-	`Plugin`.`type`	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

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

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Plugin.disposeWithMe

Defined in

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

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Plugin.ensureNotDisposed

Defined in

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

getPluginName()

getPluginName(): string

Returns

string

Inherited from

Plugin.getPluginName

Defined in

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

getUniverInstanceType()

getUniverInstanceType(): UniverInstanceType

Returns

UniverInstanceType

Inherited from

Plugin.getUniverInstanceType

Defined in

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

onReady()

onReady(): void

Returns

void

Inherited from

Plugin.onReady

Defined in

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

onRendered()

onRendered(): void

Returns

void

Inherited from

Plugin.onRendered

Defined in

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

onStarting()

onStarting(): void

Returns

void

Overrides

Plugin.onStarting

Defined in

packages/uniscript/src/plugin.ts:46 (opens in a new tab)

onSteady()

onSteady(): void

Returns

void

Overrides

Plugin.onSteady

Defined in

packages/uniscript/src/plugin.ts:59 (opens in a new tab)

registerExecution()

registerExecution(): void

Allows being overridden, replacing with a new UniscriptExecutionService.

Returns

void

Defined in

packages/uniscript/src/plugin.ts:66 (opens in a new tab)

Scripteditorservice Iuniscriptexecutionservice