IDashboardPluginBase
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
export interface IDashboardPluginBase
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| string | (ALPHA) (Optional) Plugin description. This is optional and may provide additional information about what the plugin does. | |
| string | (ALPHA) Plugin name. | |
| string[] | (ALPHA) Plugins may be tagged using arbitrary tags for additional categorization. | |
| “IDashboardPlugin” | (ALPHA) | |
| string | (ALPHA) Fully qualified URL where the plugin entry point is hosted. |
Property details
IDashboardPluginBase.descriptionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Plugin description. This is optional and may provide additional information about what the plugin does.
readonly description?: string;
IDashboardPluginBase.namepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Plugin name.
readonly name: string;
IDashboardPluginBase.tagspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Plugins may be tagged using arbitrary tags for additional categorization.
readonly tags: string[];
IDashboardPluginBase.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
readonly type: "IDashboardPlugin";
IDashboardPluginBase.urlpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Fully qualified URL where the plugin entry point is hosted.
readonly url: string;