Skip to content

Commit a4d0aa3

Browse files
committed
Update documentation
1 parent 4d94768 commit a4d0aa3

File tree

4 files changed

+11
-4
lines changed

4 files changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# <img src="src/img/plotly.svg" width="30" style="margin-bottom:-5px"> Plotly Panel
1+
# Plotly Panel
22

33
[https://github.com/ae3e/ae3e-plotly-panel](https://github.com/ae3e/ae3e-plotly-panel)
44

5-
Render chart from any datasource with [Plotly](https://plotly.com/javascript/) (An open source javascript graphing library)
5+
Render any kind of charts from any datasource with [Plotly](https://plotly.com/javascript/) (An open source javascript graphing library)
66

77
Unlike the [natel-plotly-panel](https://github.com/NatelEnergy/grafana-plotly-panel), this plugin is not limited to specific types of charts. But, on the other hand, the user interface is really rough in order to let users to set all options available in Plotly.
88

99
The *Data*, *Layout* and *Config* fields match the common parameters described in [Plotly's documentation](https://plotly.com/javascript/plotlyjs-function-reference/). They must be in JSON format.
1010

1111
Data provided by the datasource can be transformed via a user-defined script before to be injected in the Plotly chart. The script includes 2 arguments :
1212
- `data` : Data returns by the datasource
13-
- `variables` : Object that contains [Grafana's variables](https://grafana.com/docs/grafana/latest/reference/templating/) available in the current dashboard
13+
- `variables` : Object that contains [Grafana's variables](https://grafana.com/docs/grafana/latest/variables/) available in the current dashboard (user variables and few global variables : `__from`, `__to`, `__interval` and `__interval_ms`).
1414

1515
The script must return an object with one or more of the following properties : `data`, `layout`, `config`.
1616

@@ -43,4 +43,11 @@ Plotly panel editor :
4343

4444
Example of a wind rose chart :
4545

46-
![Panel](https://raw.githubusercontent.com//ae3e/ae3e-plotly-panel/master/src/img/panel.png)
46+
![Panel](https://raw.githubusercontent.com//ae3e/ae3e-plotly-panel/master/src/img/panel.png)
47+
48+
Example of heatmap and 3D chart :
49+
50+
![Panel](https://raw.githubusercontent.com//ae3e/ae3e-plotly-panel/master/src/img/panel.png2)
51+
52+
Example of custom chart and boxplot :
53+
![Panel](https://raw.githubusercontent.com//ae3e/ae3e-plotly-panel/master/src/img/panel.png3)

src/img/editor.png

54.8 KB
Loading

src/img/panel2.png

348 KB
Loading

src/img/panel3.png

83.7 KB
Loading

0 commit comments

Comments
 (0)