IDashboardPluginLink
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
A link between dashboard and a plugin that it uses. Optionally contains parameters that should be passed to the plugin at load time.
export interface IDashboardPluginLink
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| string | (ALPHA) (Optional) Contains parameters that should be passed to the plugin at load time. The format and content of the parameters are fully dependent on the implementation of the plugin. If the plugin parameterization is possible, then the plugin documentation should contain the detail. | |
| (ALPHA) Linked plugin. | ||
| “IDashboardPluginLink” | (ALPHA) |
Property details
IDashboardPluginLink.parameterspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Contains parameters that should be passed to the plugin at load time. The format and content of the parameters are fully dependent on the implementation of the plugin. If the plugin parameterization is possible, then the plugin documentation should contain the detail.
readonly parameters?: string;
IDashboardPluginLink.pluginpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Linked plugin.
readonly plugin: ObjRef;
IDashboardPluginLink.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
readonly type: "IDashboardPluginLink";