Documentation for automated readers
A curated documentation index is available at: https://grafana.com/llms.txt
A complete documentation index is available at: https://grafana.com/llms-full.txt
These indexes can help with page discovery before fetching individual documents.
This page is also available in Markdown, which may be easier for automated readers and AI tools to parse than HTML. The Markdown version is available at https://grafana.com/docs/grafana/v8.4/packages_api/data/grafanaplugin.md, or by sending Accept: text/markdown to https://grafana.com/docs/grafana/v8.4/packages_api/data/grafanaplugin/. For broader documentation discovery, the curated index is available at https://grafana.com/llms.txt and the complete index is available at https://grafana.com/llms-full.txt.
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.
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 | ||
| configPages | Array<PluginConfigPage<T>> | ||
| loadError | boolean | ||
| meta | T |
Methods
| Method | Modifiers | Description |
|---|---|---|
| addConfigPage(tab) | ||
| setChannelSupport(support) |
constructor()
Constructs a new instance of the GrafanaPlugin class
Signature
constructor();angularConfigCtrl property
Signature
angularConfigCtrl?: any;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
Signature
setChannelSupport(support: any): this;Parameters
| Parameter | Type | Description |
|---|---|---|
| support | any |
Returns:
this