@univerjs/sheets-ui v0.1.17 • Docs

Class: UniverSheetsUIPlugin

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

Extends

Plugin

Constructors

new UniverSheetsUIPlugin()

new UniverSheetsUIPlugin(
   _config, 
   _injector, 
   _renderManagerService, 
   _univerInstanceService): UniverSheetsUIPlugin

Parameters

Parameter	Type
`_config`	`Partial`<`IUniverSheetsUIConfig`>
`_injector`	`Injector`
`_renderManagerService`	`IRenderManagerService`
`_univerInstanceService`	`IUniverInstanceService`

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`	`readonly`	`Injector`	`undefined`	-	`Plugin`.`_injector`	packages/sheets-ui/src/sheets-ui-plugin.ts:94 (opens in a new tab)
`pluginName`	`static`	`string`	`'SHEET_UI_PLUGIN'`	`Plugin`.`pluginName`	-	packages/sheets-ui/src/sheets-ui-plugin.ts:89 (opens in a new tab)
`type`	`static`	`UniverInstanceType`	`UniverInstanceType.UNIVER_SHEET`	`Plugin`.`type`	-	packages/sheets-ui/src/sheets-ui-plugin.ts:90 (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()

protected 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:60 (opens in a new tab)

getUniverInstanceType()

getUniverInstanceType(): UniverInstanceType

Returns

UniverInstanceType

Inherited from

Plugin.getUniverInstanceType

Defined in

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

onReady()

onReady(): void

Returns

void

Overrides

Plugin.onReady

Defined in

packages/sheets-ui/src/sheets-ui-plugin.ts:167 (opens in a new tab)

onRendered()

onRendered(): void

Returns

void

Overrides

Plugin.onRendered

Defined in

packages/sheets-ui/src/sheets-ui-plugin.ts:172 (opens in a new tab)

onStarting()

onStarting(injector): void

Parameters

Parameter	Type
`injector`	`Injector`

Returns

void

Overrides

Plugin.onStarting

Defined in

packages/sheets-ui/src/sheets-ui-plugin.ts:103 (opens in a new tab)

onSteady()

onSteady(): void

Returns

void

Inherited from

Plugin.onSteady

Defined in

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

Statusbarcontroller Apply Type