@univerjsslidesclassesUniverslidesplugin

@univerjs/slides v0.5.0-beta.1 • Docs

Class: UniverSlidesPlugin

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

Parameters

ParameterTypeDefault value
_configPartial<IUniverSlidesConfig>defaultPluginConfig
_injectorInjectorundefined
_renderManagerServiceIRenderManagerServiceundefined
_configServiceIConfigServiceundefined

Returns

UniverSlidesPlugin

Overrides

Plugin.constructor

Defined in

slides/src/slides-plugin.ts:39

Properties

PropertyModifierTypeDefault valueOverridesInherited fromDefined in
_disposedprotectedbooleanfalse-Plugin._disposedcore/src/shared/lifecycle.ts:93
_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

Returns

void

Inherited from

Plugin.dispose

Defined in

core/src/shared/lifecycle.ts:106

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Plugin.disposeWithMe

Defined in

core/src/shared/lifecycle.ts:96

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Plugin.ensureNotDisposed

Defined in

core/src/shared/lifecycle.ts:100

getCanvasEngine()

getCanvasEngine(): null | Engine

Returns

null | Engine

Defined in

slides/src/slides-plugin.ts:74

getConfig()

getConfig(): Partial<IUniverSlidesConfig>

Returns

Partial<IUniverSlidesConfig>

Defined in

slides/src/slides-plugin.ts:62

getPluginName()

getPluginName(): string

Returns

string

Inherited from

Plugin.getPluginName

Defined in

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

getUniverInstanceType()

getUniverInstanceType(): UniverInstanceType

Returns

UniverInstanceType

Inherited from

Plugin.getUniverInstanceType

Defined in

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

initCanvasEngine()

initCanvasEngine(): void

Returns

void

Defined in

slides/src/slides-plugin.ts:66

initialize()

initialize(): void

Returns

void

Defined in

slides/src/slides-plugin.ts:54

onReady()

onReady(): void

Returns

void

Overrides

Plugin.onReady

Defined in

slides/src/slides-plugin.ts:58

onRendered()

onRendered(): void

Returns

void

Overrides

Plugin.onRendered

Defined in

slides/src/slides-plugin.ts:70

onStarting()

onStarting(): void

Returns

void

Inherited from

Plugin.onStarting

Defined in

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

onSteady()

onSteady(): void

Returns

void

Inherited from

Plugin.onSteady

Defined in

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

ObjectproviderSlide Key