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, 
   _univerInstanceService, 
   _localeService, 
   _injector): UniverSlidesPlugin

Parameters

Parameter	Type
`config`	`Partial`<`IUniverSlidesConfig`>
`_univerInstanceService`	`IUniverInstanceService`
`_localeService`	`LocaleService`
`_injector`	`Injector`

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:45 (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()

protected 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:69 (opens in a new tab)

getCanvasView()

getCanvasView(): null | CanvasView

Returns

null | CanvasView

Defined in

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

getConfig()

getConfig(): IUniverSlidesConfig

Returns

IUniverSlidesConfig

Defined in

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

getPluginName()

getPluginName(): string

Returns

string

Inherited from

Plugin.getPluginName

Defined in

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

getUniverInstanceType()

getUniverInstanceType(): UniverInstanceType

Returns

UniverInstanceType

Inherited from

Plugin.getUniverInstanceType

Defined in

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

initCanvasEngine()

initCanvasEngine(): void

Returns

void

Defined in

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

initialize()

initialize(): void

Returns

void

Defined in

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

onReady()

onReady(): void

Returns

void

Inherited from

Plugin.onReady

Defined in

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

onRendered()

onRendered(): void

Returns

void

Overrides

Plugin.onRendered

Defined in

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

onStarting()

onStarting(injector): void

Parameters

Parameter	Type
`injector`	`Injector`

Returns

void

Inherited from

Plugin.onStarting

Defined in

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

onSteady()

onSteady(): void

Returns

void

Inherited from

Plugin.onSteady

Defined in

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

Canvasview Slide Key