diff --git a/docs/dashboards.md b/docs/dashboards.md index 2ae86a3279..59a6086898 100644 --- a/docs/dashboards.md +++ b/docs/dashboards.md @@ -1,4 +1,5 @@ ## Dashboard API +The dashboard API will support collections of resizable InfluxQL visualizations. ### TL; DR 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 +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 #### GET /dashboards @@ -136,7 +157,8 @@ Returns a list of dashboards ``` #### 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 { @@ -206,4 +228,4 @@ The queries endpoint will be a simple CRUD endpoint storing the raw query: ``` Over time I'd like this queries endpoint to support a `format` parameter to return -the query data in different JSON formats such as `QueryConfig`. \ No newline at end of file +the query data in different JSON formats such as `QueryConfig`.