mirror of
https://github.com/grafana/grafana.git
synced 2025-07-29 20:52:21 +08:00
cc3fc18076
* added packages reference menu item. * removed the draft flag. * Updated docs by running script.
102 lines
2.0 KiB
Markdown
102 lines
2.0 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "GrafanaPlugin"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
+++
|
|
|
|
## GrafanaPlugin class
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export declare class GrafanaPlugin<T extends PluginMeta = PluginMeta>
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { GrafanaPlugin } from '@grafana/data';
|
|
```
|
|
<b>Constructors</b>
|
|
|
|
| Constructor | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [constructor()](#constructor-) | | Constructs a new instance of the <code>GrafanaPlugin</code> class |
|
|
|
|
<b>Properties</b>
|
|
|
|
| Property | Modifiers | Type | Description |
|
|
| --- | --- | --- | --- |
|
|
| [angularConfigCtrl](#angularconfigctrl-property) | | <code>any</code> | |
|
|
| [configPages](#configpages-property) | | <code>Array<PluginConfigPage<T>></code> | |
|
|
| [loadError](#loaderror-property) | | <code>boolean</code> | |
|
|
| [meta](#meta-property) | | <code>T</code> | |
|
|
|
|
<b>Methods</b>
|
|
|
|
| Method | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [addConfigPage(tab)](#addconfigpage-method) | | |
|
|
|
|
### constructor()
|
|
|
|
Constructs a new instance of the `GrafanaPlugin` class
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
constructor();
|
|
```
|
|
|
|
### angularConfigCtrl property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
angularConfigCtrl?: any;
|
|
```
|
|
|
|
### configPages property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
configPages?: Array<PluginConfigPage<T>>;
|
|
```
|
|
|
|
### loadError property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
loadError?: boolean;
|
|
```
|
|
|
|
### meta property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
meta: T;
|
|
```
|
|
|
|
### addConfigPage method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
addConfigPage(tab: PluginConfigPage<T>): this;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| tab | <code>PluginConfigPage<T></code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`this`
|
|
|