@univerjs/watermark v0.5.0-beta.1 • Docs
Class: UniverWatermarkPlugin
Plug-in base class, all plug-ins must inherit from this base class. Provide basic methods.
Extends
Constructors
new UniverWatermarkPlugin()
new UniverWatermarkPlugin(
_config,
_injector,
_configService,
_renderManagerSrv,
_localStorageService): UniverWatermarkPlugin
Parameters
Parameter | Type |
---|---|
_config | Partial <IUniverWatermarkConfig > |
_injector | Injector |
_configService | IConfigService |
_renderManagerSrv | IRenderManagerService |
_localStorageService | ILocalStorageService |
Returns
Overrides
Defined in
watermark/src/plugin.ts:32
Properties
Property | Modifier | Type | Default value | Overrides | Inherited from | Defined in |
---|---|---|---|---|---|---|
_disposed | protected | boolean | false | - | Plugin ._disposed | core/src/shared/lifecycle.ts:93 |
_injector | protected | Injector | undefined | - | Plugin ._injector | watermark/src/plugin.ts:34 |
pluginName | static | string | PLUGIN_NAME | Plugin .pluginName | - | watermark/src/plugin.ts:30 |
type | static | UniverInstanceType | UniverInstanceType.UNIVER_UNKNOWN | - | Plugin .type | core/src/services/plugin/plugin.ts:35 |
Methods
dispose()
dispose(): void
Returns
void
Inherited from
Defined in
core/src/shared/lifecycle.ts:106
disposeWithMe()
disposeWithMe(disposable): IDisposable
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
Inherited from
Defined in
core/src/shared/lifecycle.ts:96
ensureNotDisposed()
protected ensureNotDisposed(): void
Returns
void
Inherited from
Defined in
core/src/shared/lifecycle.ts:100
getPluginName()
getPluginName(): string
Returns
string
Inherited from
Defined in
core/src/services/plugin/plugin.ts:59
getUniverInstanceType()
getUniverInstanceType(): UniverInstanceType
Returns
Inherited from
Defined in
core/src/services/plugin/plugin.ts:55
onReady()
onReady(): void
Returns
void
Inherited from
Defined in
core/src/services/plugin/plugin.ts:43
onRendered()
onRendered(): void
Returns
void
Overrides
Defined in
watermark/src/plugin.ts:67
onStarting()
onStarting(): void
Returns
void
Inherited from
Defined in
core/src/services/plugin/plugin.ts:39
onSteady()
onSteady(): void
Returns
void
Inherited from
Defined in
core/src/services/plugin/plugin.ts:51