API Reference
@univerjs
@univerjs/sheets
classes
Universheetsplugin

@univerjs/sheets v0.1.17Docs


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

ParameterType
_configundefined | IUniverSheetsConfig
_commandServiceICommandService
_configServiceIConfigService
_localeServiceLocaleService
_injectorInjector

Returns

UniverSheetsPlugin

Overrides

Plugin.constructor

Defined in

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

Properties

PropertyModifierTypeDefault valueOverridesInherited fromDefined in
_disposedprotectedbooleanfalse-Plugin._disposedpackages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
_injectorreadonlyInjectorundefined-Plugin._injectorpackages/sheets/src/sheets-plugin.ts:69 (opens in a new tab)
pluginNamestaticstringPLUGIN_NAMEPlugin.pluginName-packages/sheets/src/sheets-plugin.ts:61 (opens in a new tab)
typestaticUniverInstanceTypeUniverInstanceType.UNIVER_SHEETPlugin.type-packages/sheets/src/sheets-plugin.ts:62 (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

ParameterType
disposableDisposableLike

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

Inherited from

Plugin.onReady

Defined in

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


onRendered()

onRendered(): void

Returns

void

Overrides

Plugin.onRendered

Defined in

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


onStarting()

onStarting(injector): void

Parameters

ParameterType
injectorInjector

Returns

void

Inherited from

Plugin.onStarting

Defined in

packages/core/src/services/plugin/plugin.ts:40 (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)


Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.