@univerjs/sheets v0.1.17 • Docs
Class: UniverSheetsPlugin
The main sheet base, construct the sheet container and layout, mount the rendering engine
Extends
Constructors
new UniverSheetsPlugin()
new UniverSheetsPlugin(
_config,
_commandService,
_configService,
_localeService,
_injector): UniverSheetsPlugin
Parameters
Parameter | Type |
---|---|
_config | undefined | IUniverSheetsConfig |
_commandService | ICommandService |
_configService | IConfigService |
_localeService | LocaleService |
_injector | Injector |
Returns
Overrides
Defined in
packages/sheets/src/sheets-plugin.ts:64 (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:69 (opens in a new tab) |
pluginName | static | string | PLUGIN_NAME | Plugin .pluginName | - | packages/sheets/src/sheets-plugin.ts:61 (opens in a new tab) |
type | static | UniverInstanceType | UniverInstanceType.UNIVER_SHEET | Plugin .type | - | packages/sheets/src/sheets-plugin.ts:62 (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()
protected disposeWithMe(disposable): IDisposable
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
IDisposable
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:60 (opens in a new tab)
getUniverInstanceType()
getUniverInstanceType(): UniverInstanceType
Returns
Inherited from
Defined in
packages/core/src/services/plugin/plugin.ts:56 (opens in a new tab)
onReady()
onReady(): void
Returns
void
Inherited from
Defined in
packages/core/src/services/plugin/plugin.ts:44 (opens in a new tab)
onRendered()
onRendered(): void
Returns
void
Overrides
Defined in
packages/sheets/src/sheets-plugin.ts:77 (opens in a new tab)
onStarting()
onStarting(injector): void
Parameters
Parameter | Type |
---|---|
injector | Injector |
Returns
void
Inherited from
Defined in
packages/core/src/services/plugin/plugin.ts:40 (opens in a new tab)
onSteady()
onSteady(): void
Returns
void
Inherited from
Defined in
packages/core/src/services/plugin/plugin.ts:52 (opens in a new tab)