Commit 01d5bc73 by bergquist

docs(plugins): add css to panel example

parent f3b915c4
...@@ -20,7 +20,7 @@ To interact with the rest of grafana the plugins module file can export 5 differ ...@@ -20,7 +20,7 @@ To interact with the rest of grafana the plugins module file can export 5 differ
## Plugin json ## Plugin json
There are two datasource specific settings for the plugin.json There are two datasource specific settings for the plugin.json
``` ```javascript
"metrics": true, "metrics": true,
"annotations": false, "annotations": false,
``` ```
......
...@@ -4,7 +4,25 @@ page_description: Panel plugins for Grafana ...@@ -4,7 +4,25 @@ page_description: Panel plugins for Grafana
page_keywords: grafana, plugins, documentation 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 # 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.
\ No newline at end of file
.panel-boilerplate-values {
text-align: center;
}
\ No newline at end of file
define([ define([
'app/plugins/sdk', 'app/plugins/sdk',
'lodash' 'lodash',
'./css/styles.css!'
], function(sdk, _) { ], function(sdk, _) {
var BoilerPlatePanelCtrl = (function(_super) { var BoilerPlatePanelCtrl = (function(_super) {
......
...@@ -2,6 +2,6 @@ ...@@ -2,6 +2,6 @@
Basic panel Basic panel
</h2> </h2>
<p class="text-center">{{ctrl.values}}</p> <p class="panel-boilerplate-values">{{ctrl.values}}</p>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment