API Reference
@univerjs
@univerjs/drawing
classes
Univerdrawingplugin

@univerjs/drawing v0.1.17Docs


Class: UniverDrawingPlugin

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

Extends

Constructors

new UniverDrawingPlugin()

new UniverDrawingPlugin(_config, _injector): UniverDrawingPlugin

Parameters

ParameterType
_configobject
_config.override?DependencyOverride
_injectorInjector

Returns

UniverDrawingPlugin

Overrides

Plugin.constructor

Defined in

packages/drawing/src/plugin.ts:32 (opens in a new tab)

Properties

PropertyModifierTypeDefault valueOverridesInherited fromDefined in
_disposedprotectedbooleanfalse-Plugin._disposedpackages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
_injectorprotectedInjectorundefined-Plugin._injectorpackages/drawing/src/plugin.ts:34 (opens in a new tab)
pluginNamestaticstringPLUGIN_NAMEPlugin.pluginName-packages/drawing/src/plugin.ts:30 (opens in a new tab)
typestaticUniverInstanceTypeUniverInstanceType.UNIVER_UNKNOWN-Plugin.typepackages/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()

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

Inherited from

Plugin.onRendered

Defined in

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


onStarting()

onStarting(_injector): void

Parameters

ParameterType
_injectorInjector

Returns

void

Overrides

Plugin.onStarting

Defined in

packages/drawing/src/plugin.ts:39 (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.