Class: UniverSlidesPlugin

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

Extends

Plugin

Constructors

new UniverSlidesPlugin()

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

Parameters

Parameter	Type	Default value
`_config`	`Partial`<`IUniverSlidesConfig`>	`defaultPluginConfig`
`_injector`	`Injector`	`undefined`
`_renderManagerService`	`IRenderManagerService`	`undefined`
`_configService`	`IConfigService`	`undefined`

Properties

Property	Modifier	Type	Default value	Overrides	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	-	`Plugin`.`_disposed`	core/src/shared/lifecycle.ts:93 (opens in a new tab)
`_injector`	`readonly`	`Injector`	`undefined`	-	`Plugin`.`_injector`	slides/src/slides-plugin.ts:41 (opens in a new tab)
`pluginName`	`static`	`string`	`PLUGIN_NAME`	`Plugin`.`pluginName`	-	slides/src/slides-plugin.ts:32 (opens in a new tab)
`type`	`static`	`UniverInstanceType`	`UniverInstanceType.UNIVER_SLIDE`	`Plugin`.`type`	-	slides/src/slides-plugin.ts:33 (opens in a new tab)

Methods

dispose()

dispose(): void

Returns

void

Inherited from

Plugin.dispose

Defined in

core/src/shared/lifecycle.ts:106 (opens in a new tab)

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Plugin.disposeWithMe

Defined in

core/src/shared/lifecycle.ts:96 (opens in a new tab)

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Plugin.ensureNotDisposed

Defined in

core/src/shared/lifecycle.ts:100 (opens in a new tab)

getCanvasEngine()

getCanvasEngine(): null | Engine

Returns

null | Engine

Defined in

slides/src/slides-plugin.ts:74 (opens in a new tab)

getConfig()

getConfig(): Partial<IUniverSlidesConfig>

Returns

Partial<IUniverSlidesConfig>

Defined in

slides/src/slides-plugin.ts:62 (opens in a new tab)

getPluginName()

getPluginName(): string

Returns

string

Inherited from

Plugin.getPluginName

Defined in

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

getUniverInstanceType()

getUniverInstanceType(): UniverInstanceType

Returns

UniverInstanceType

Inherited from

Plugin.getUniverInstanceType

Defined in

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

initCanvasEngine()

initCanvasEngine(): void

Returns

void

Defined in

slides/src/slides-plugin.ts:66 (opens in a new tab)

initialize()

initialize(): void

Returns

void

Defined in

slides/src/slides-plugin.ts:54 (opens in a new tab)

onReady()

onReady(): void

Returns

void

Overrides

Plugin.onReady

Defined in

slides/src/slides-plugin.ts:58 (opens in a new tab)

onRendered()

onRendered(): void

Returns

void

Overrides

Plugin.onRendered

Defined in

slides/src/slides-plugin.ts:70 (opens in a new tab)

onStarting()

onStarting(): void

Returns

void

Inherited from

Plugin.onStarting

Defined in

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

onSteady()

onSteady(): void

Returns

void

Inherited from

Plugin.onSteady

Defined in

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

Objectprovider Slide Key