@univerjs/sheets v0.4.2 • Docs
Class: UniverSheetsPlugin
Plug-in base class, all plug-ins must inherit from this base class. Provide basic methods.
Extends
Constructors
new UniverSheetsPlugin()
new UniverSheetsPlugin(
_config,
_injector,
_configService): UniverSheetsPlugin
Parameters
Parameter | Type | Default value |
---|---|---|
_config | Partial <IUniverSheetsConfig > | defaultPluginConfig |
_injector | Injector | undefined |
_configService | IConfigService | undefined |
Returns
Overrides
Defined in
packages/sheets/src/sheets-plugin.ts:51 (opens in a new tab)
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/src/sheets-plugin.ts:53 (opens in a new tab) |
pluginName | static | string | PLUGIN_NAME | Plugin .pluginName | - | packages/sheets/src/sheets-plugin.ts:48 (opens in a new tab) |
type | static | UniverInstanceType | UniverInstanceType.UNIVER_SHEET | Plugin .type | - | packages/sheets/src/sheets-plugin.ts:49 (opens in a new tab) |
Methods
dispose()
dispose(): void
Returns
void
Inherited from
Defined in
packages/core/src/shared/lifecycle.ts:106 (opens in a new tab)
disposeWithMe()
disposeWithMe(disposable): IDisposable
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
Inherited from
Defined in
packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)
ensureNotDisposed()
protected ensureNotDisposed(): void
Returns
void
Inherited from
Defined in
packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)
getPluginName()
getPluginName(): string
Returns
string
Inherited from
Defined in
packages/core/src/services/plugin/plugin.ts:59 (opens in a new tab)
getUniverInstanceType()
getUniverInstanceType(): UniverInstanceType
Returns
Inherited from
Defined in
packages/core/src/services/plugin/plugin.ts:55 (opens in a new tab)
onReady()
onReady(): void
Returns
void
Overrides
Defined in
packages/sheets/src/sheets-plugin.ts:136 (opens in a new tab)
onRendered()
onRendered(): void
Returns
void
Overrides
Defined in
packages/sheets/src/sheets-plugin.ts:130 (opens in a new tab)
onStarting()
onStarting(): void
Returns
void
Overrides
Defined in
packages/sheets/src/sheets-plugin.ts:121 (opens in a new tab)
onSteady()
onSteady(): void
Returns
void
Inherited from
Defined in
packages/core/src/services/plugin/plugin.ts:51 (opens in a new tab)