Influxdata
/
influxdb
mirror of https://github.com/influxdata/influxdb.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update dashboard design to include answers to spike

pull/10616/head
Chris Goller 2016-12-06 11:22:27 -06:00
parent 0b789329c6
commit 77224f9d26
1 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/dashboards.md
View File

@ -1,4 +1,5 @@
## Dashboard API ## Dashboard API
The dashboard API will support collections of resizable InfluxQL visualizations.
### TL; DR ### TL; DR
Here are the objects we are thinking about; dashboards contain layouts which Here are the objects we are thinking about; dashboards contain layouts which
@ -55,8 +56,28 @@ contain explorations.
} }
``` ```
## Older Chronograf dashboards
Older chronograf dashboards had the following features:
* View Dashboard
* Add new visualization to dashboard
* Add existing visualization to dashboard
* Remove visualizatoin from dashboard
* Naming of dashboards
* Delete dashboard
* Edit visualization in dashboard
## API ## API
This API supports a user defined grid layout by specifying `x`, `y`, `w`, `h`.
These fields align with the [react-grid-layout](https://github.com/STRML/react-grid-layout#usage)
methodology.
This layout style has:
* Draggable query cells
* Resizable query cells
* Vertical auto-packing
### /dashboards ### /dashboards
#### GET /dashboards #### GET /dashboards
@ -136,7 +157,8 @@ Returns a list of dashboards
``` ```
#### GET /dashboards/myid #### GET /dashboards/myid
Returns an single dashboard object Returns an single dashboard object. The fields `x`, `y`, `w`, `h`, default to
not existing unless a user has modified the particular cell.
```json ```json
{ {