Skip to content

Commit 0afe59f

Browse files
authored
Update README with dashboard layout examples
1 parent 54a41a2 commit 0afe59f

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1212
- Enable extra extensions for Markdown rendering
1313

1414
### Changed
15+
- Update README with dashboard layout examples
1516
- Update dependencies
1617

1718
## [0.5.3] - 2023-06-05

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,27 @@ define the `layout` array property as a grid / matrix:
236236

237237
- Each entry represents a row of charts
238238
- Each column is referring a chart by its property name
239+
- An empty slot in the grid can be specified using the `.` (_full stop_) placeholder
240+
241+
**WARNINGS**:
242+
- All rows must specify the same number of columns
243+
- All charts must be placed somewhere on the custom layout
244+
245+
Here is a simple 2x3 grid example with 4 different charts:
246+
247+
```yaml
248+
layout:
249+
- [chart1, chart2, chart3]
250+
- [chart1, chart4, chart4]
251+
```
252+
253+
Here is a more subtle example involving an empty spot at the end of the second row:
254+
255+
```yaml
256+
layout:
257+
- [chart1, chart2, chart3]
258+
- [chart1, chart4, .]
259+
```
239260

240261
### Embedding dashboards and charts
241262

0 commit comments

Comments
 (0)