Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentation Grafana documentation API Reference @grafana/data GrafanaPlugin

GrafanaPlugin class

Signature

typescript Copy

export declare class GrafanaPlugin<T extends PluginMeta = PluginMeta> 

Import

typescript Copy

import { GrafanaPlugin } from '@grafana/data';

Constructors

Properties

Methods

constructor()

Constructs a new instance of the GrafanaPlugin class

Signature

typescript Copy

constructor();

angularConfigCtrl property

Signature

typescript Copy

angularConfigCtrl?: any;

channelSupport property

Live streaming support

Note: plugin.json must also define live: true

Signature

typescript Copy

channelSupport?: LiveChannelSupport;

configPages property

Signature

typescript Copy

configPages?: Array<PluginConfigPage<T>>;

loadError property

Signature

typescript Copy

loadError?: boolean;

meta property

Signature

typescript Copy

meta: T;

addConfigPage method

Signature

typescript Copy

addConfigPage(tab: PluginConfigPage<T>): this;

Parameters

Returns:

this

setChannelSupport method

Specify how the plugin should support paths within the live streaming environment

Signature

typescript Copy

setChannelSupport(support: LiveChannelSupport): this;

Parameters

Returns:

this