GrafanaPlugin class

Signature

  1. export declare class GrafanaPlugin<T extends PluginMeta = PluginMeta>

Import

  1. 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

  1. constructor();

angularConfigCtrl property

Signature

  1. angularConfigCtrl?: any;

channelSupport property

Live streaming support

Note: plugin.json must also define live: true

Signature

  1. channelSupport?: LiveChannelSupport;

configPages property

Signature

  1. configPages?: Array<PluginConfigPage<T>>;

loadError property

Signature

  1. loadError?: boolean;

meta property

Signature

  1. meta: T;

addConfigPage method

Signature

  1. 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

  1. setChannelSupport(support: LiveChannelSupport): this;

Parameters

ParameterTypeDescription
supportLiveChannelSupport

Returns:

this