opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-08-02 11:34:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(plugins): add css to panel example

Browse Source
This commit is contained in:
bergquist
2016-03-04 13:10:33 +01:00
parent f3b915c43a
commit 01d5bc73cc
5 changed files with 26 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/sources/plugins/datasources.md
View File

@ -20,7 +20,7 @@ To interact with the rest of grafana the plugins module file can export 5 differ
## Plugin json
There are two datasource specific settings for the plugin.json
```
```javascript
"metrics": true,
"annotations": false,
```

20
docs/sources/plugins/panels.md
View File

@ -4,7 +4,25 @@ page_description: Panel plugins for Grafana
page_keywords: grafana, plugins, documentation
---
> Our goal is not to have a very extensive documentation but rather have actual code that people can look at. An example implementation of a datasource can be found in the grafana repo under /examples/panel-boilerplate-es5
# Panels
TODO
To interact with the rest of grafana the panel plugin need to export a class in the module.js.
This class have to inherit from sdk.PanelCtrl or sdk.MetricsPanelCtrl and be exported as PanelCtrl.
```javascript
return {
PanelCtrl: BoilerPlatePanelCtrl
};
```
This class will be instancieted once for every panel of its kind in a dashboard and treated as an AngularJs controller.
## MetricsPanelCtrl or PanelCtrl
MetricsPanelCtrl inherits from PanelCtrl and adds some common features for datasource usage. So if your Panel will be working with a datasource you should inherit from MetricsPanelCtrl. If dont need to access any datasource then you should inherit from PanelCtrl instead.
## Implementing a MetricsPanelCtrl
If you choose to inherit from MetricsPanelCtrl you should implement a function called refreshData that will be called by grafana when its time for all panels to get new data.