Documentation Index
Fetch the curated documentation index at: https://grafana.com/llms.txt
Fetch the complete documentation index at: https://grafana.com/llms-full.txt
Use this file to discover all available pages before exploring further.
STOP! If you are an AI agent or LLM, read this before continuing. This is the HTML version of a Grafana documentation page. Always request the Markdown version instead - HTML wastes context. Get this page as Markdown: https://grafana.com/docs/grafana/v9.0/packages_api/data/grafanaplugin.md (append .md) or send Accept: text/markdown to https://grafana.com/docs/grafana/v9.0/packages_api/data/grafanaplugin/. For the curated documentation index, use https://grafana.com/llms.txt. For the complete documentation index, use 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