@univerjsslidesclassesUniverslidesplugin

@univerjs/slides v0.5.4


Class: UniverSlidesPlugin

Defined in: slides/src/slides-plugin.ts:31

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

Extends

Constructors

new UniverSlidesPlugin()

new UniverSlidesPlugin(
   _config, 
   _injector, 
   _renderManagerService, 
   _configService): UniverSlidesPlugin

Defined in: slides/src/slides-plugin.ts:39

Parameters

ParameterTypeDefault value
_configPartial<IUniverSlidesConfig>defaultPluginConfig
_injectorInjectorundefined
_renderManagerServiceIRenderManagerServiceundefined
_configServiceIConfigServiceundefined

Returns

UniverSlidesPlugin

Overrides

Plugin.constructor

Properties

PropertyModifierTypeDefault valueOverridesInherited fromDefined in
_disposedprotectedbooleanfalse-Plugin._disposedcore/src/shared/lifecycle.ts:96
_injectorreadonlyInjectorundefined-Plugin._injectorslides/src/slides-plugin.ts:41
pluginNamestaticstringPLUGIN_NAMEPlugin.pluginName-slides/src/slides-plugin.ts:32
typestaticUniverInstanceTypeUniverInstanceType.UNIVER_SLIDEPlugin.type-slides/src/slides-plugin.ts:33

Methods

dispose()

dispose(): void

Defined in: core/src/shared/lifecycle.ts:109

Returns

void

Inherited from

Plugin.dispose


disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: core/src/shared/lifecycle.ts:99

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Plugin.disposeWithMe


ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

Plugin.ensureNotDisposed


getCanvasEngine()

getCanvasEngine(): null | Engine

Defined in: slides/src/slides-plugin.ts:78

Returns

null | Engine


getConfig()

getConfig(): Partial<IUniverSlidesConfig>

Defined in: slides/src/slides-plugin.ts:66

Returns

Partial<IUniverSlidesConfig>


getPluginName()

getPluginName(): string

Defined in: core/src/services/plugin/plugin.ts:59

Returns

string

Inherited from

Plugin.getPluginName


getUniverInstanceType()

getUniverInstanceType(): UniverInstanceType

Defined in: core/src/services/plugin/plugin.ts:55

Returns

UniverInstanceType

Inherited from

Plugin.getUniverInstanceType


initCanvasEngine()

initCanvasEngine(): void

Defined in: slides/src/slides-plugin.ts:70

Returns

void


initialize()

initialize(): void

Defined in: slides/src/slides-plugin.ts:58

Returns

void


onReady()

onReady(): void

Defined in: slides/src/slides-plugin.ts:62

Returns

void

Overrides

Plugin.onReady


onRendered()

onRendered(): void

Defined in: slides/src/slides-plugin.ts:74

Returns

void

Overrides

Plugin.onRendered


onStarting()

onStarting(): void

Defined in: core/src/services/plugin/plugin.ts:39

Returns

void

Inherited from

Plugin.onStarting


onSteady()

onSteady(): void

Defined in: core/src/services/plugin/plugin.ts:51

Returns

void

Inherited from

Plugin.onSteady