Menu

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.

Enterprise Open source

GrafanaPlugin class

Signature

typescript
export declare class GrafanaPlugin<T extends PluginMeta = PluginMeta> 

Import

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

Constructors

ConstructorModifiersDescription
constructor()Constructs a new instance of the GrafanaPlugin class

Properties

PropertyModifiersTypeDescription
angularConfigCtrlany
channelSupportLiveChannelSupportLive streaming supportNote: plugin.json must also define live: true
configPagesArray<PluginConfigPage<T>>
loadErrorboolean
metaT

Methods

MethodModifiersDescription
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

typescript
constructor();

angularConfigCtrl property

Signature

typescript
angularConfigCtrl?: any;

channelSupport property

Live streaming support

Note: plugin.json must also define live: true

Signature

typescript
channelSupport?: LiveChannelSupport;

configPages property

Signature

typescript
configPages?: Array<PluginConfigPage<T>>;

loadError property

Signature

typescript
loadError?: boolean;

meta property

Signature

typescript
meta: T;

addConfigPage method

Signature

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

Parameters

ParameterTypeDescription
tabPluginConfigPage<T>

Returns:

this

setChannelSupport method

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

Signature

typescript
setChannelSupport(support: LiveChannelSupport): this;

Parameters

ParameterTypeDescription
supportLiveChannelSupport

Returns:

this