GrafanaPlugin class
Signature
export declare class GrafanaPlugin<T extends PluginMeta = PluginMeta>
Import
import { GrafanaPlugin } from '@grafana/data';
Constructors
Constructor | Modifiers | Description |
---|---|---|
constructor() | Constructs a new instance of the GrafanaPlugin class |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
angularConfigCtrl | any | ||
channelSupport | LiveChannelSupport | Live streaming supportNote: plugin.json must also define live: true | |
configPages | Array<PluginConfigPage<T>> | ||
loadError | boolean | ||
meta | T |
Methods
Method | Modifiers | Description |
---|---|---|
addConfigPage(tab) | ||
setChannelSupport(support) | Specify how the plugin should support paths within the live streaming environment |
constructor()
Constructs a new instance of the GrafanaPlugin
class
Signature
constructor();
angularConfigCtrl property
Signature
angularConfigCtrl?: any;
channelSupport property
Live streaming support
Note: plugin.json
must also define live: true
Signature
channelSupport?: LiveChannelSupport;
configPages property
Signature
configPages?: Array<PluginConfigPage<T>>;
loadError property
Signature
loadError?: boolean;
meta property
Signature
meta: T;
addConfigPage method
Signature
addConfigPage(tab: PluginConfigPage<T>): this;
Parameters
Parameter | Type | Description |
---|---|---|
tab | PluginConfigPage<T> |
Returns:
this
setChannelSupport method
Specify how the plugin should support paths within the live streaming environment
Signature
setChannelSupport(support: LiveChannelSupport): this;
Parameters
Parameter | Type | Description |
---|---|---|
support | LiveChannelSupport |
Returns:
this