class
Source: plugin.ts ↗
DashboardPluginV1
Abstract base class for the Dashboard Plugin.
export declare abstract class DashboardPluginV1 implements IDashboardPluginContract_V1
Implements: IDashboardPluginContract_V1
Remarks
Each plugin should extend this class and implement at least the DashboardPluginV1.register() method.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| (not declared) | ||
| string | ||
| string | undefined | ||
| string | ||
| string | (Optional) | |
| string | ||
| string |
Methods
Method | Modifiers | Description |
|---|---|---|
|
Property details
DashboardPluginV1._pluginVersionproperty
readonly _pluginVersion = "1.0";
DashboardPluginV1.authorproperty
abstract readonly author: string;
DashboardPluginV1.compatibilityproperty
readonly compatibility: string | undefined;
DashboardPluginV1.displayNameproperty
abstract readonly displayName: string;
DashboardPluginV1.maxEngineVersionproperty
readonly maxEngineVersion?: string;
DashboardPluginV1.minEngineVersionproperty
readonly minEngineVersion: string;
DashboardPluginV1.versionproperty
abstract readonly version: string;
Method details
DashboardPluginV1.register()method
abstract register(ctx: DashboardContext, customize: IDashboardCustomizer, handlers: IDashboardEventHandling): void;
Parameters
Parameter | Type | Description |
|---|---|---|
ctx | ||
customize | ||
handlers |
Returns
void