Skip to content

Dashboard

A Dashboard property holds blocks as tiles. Each tile holds one block and has a place and a size on a grid of 12 columns.

Example: in Diary, “Today” is a Dashboard property. The entry “28 Oct” has two tiles side by side: a steps chart and a sleep chart. Both charts use the filter “this entry’s date”, so they show 28 Oct only.

On a computer, the Today Dashboard property of 28 Oct has 12 columns. The steps chart fills columns 1 to 6 and the sleep chart fills columns 7 to 12. On a phone the two tiles stack into one column.28 Oct · Today, on a computerChart: stepsx=1 w=6Chart: sleepx=7 w=612 columns: drag to move, drag a corner to resizeOn a phoneChart: stepsChart: sleepone column, reading order
Each tile has a place and a size. On a phone the tiles stack in reading order.

Rules

  • Each tile holds one block: any writing, media or data block. See Blocks and charts.
  • You drag a tile to move it, and drag its corner to resize it.
  • On a phone, the tiles stack into one column, in reading order: left to right, then top to bottom.
  • A Dashboard needs no Columns block. Its tiles already sit side by side.
  • Any collection can have a Dashboard, not only Dashboards.
  • A dashboard is an entry in the Dashboards collection. Its Dashboard property is called “Dashboard”, and its entry page shows it at full width.
  • A tile can hold an Entry block that shows another entry’s Dashboard or Block page, such as a dashboard inside a dashboard. At most 3 levels, and no loops. A tile that shows a Dashboard must be at least 6 columns wide and 4 rows high (a theme setting); a smaller tile shows the entry’s card. See Entry block.
  • An entry tab or an Entry block can show this Dashboard property alone, as one property: only its tiles. In a block, a small header with the entry’s icon and name sits on top. A dashboard tab does this by default. See Hubs and tabs.
  • A Chart or View block in a tile can use the filter this entry’s date. See Block pages and dashboards.
  • A preset can hold starting tiles. The “Diary day” preset fills “Today” with a steps chart (from Activity) and a sleep chart (from Sleep).

Why a Dashboard is its own type

A Dashboard saves more than its blocks: it also saves each tile’s place and size. A format, such as a Number shown as stars, never changes what is saved. So a Dashboard is a type, not a format of the Block page type.

Change it to a Block page

You can change a Dashboard property into a Block page. Every block is kept: the tiles become blocks, in reading order. Tiles side by side become a Columns block. See Changing a property type.

How edits merge

A Dashboard merges tile by tile. If you move one tile on your laptop and change another on your phone while offline, both changes are kept. (The merge uses Loro, the same library as the Block page type.)

Settings

Setting What it does Example
Name The name you see. Today

The gap between tiles and the look of the tile frames are design settings. See Themes.

How it shows

Place Shows
Entry page the tiles, at their places and sizes
Entry page on a phone the tiles in one column, in reading order
A tab or an Entry block that shows it as one property the same tiles as on the entry page, and you can drag and resize them there
Card not decided yet
List and table row not decided yet

In the folder

A Dashboard is a section of the entry’s markdown file, after a marker line. Each tile has its own marker, followed by its block.

---
title: 28 Oct
mood: 7
---
<!-- document: Liked today -->
Long run before work.
<!-- grid: Today -->
<!-- tile: x=1 y=1 w=6 h=4 -->
```kzx-chart
{ "version": 1, "kind": "bar", "collection": "Activity", "dateFilter": "thisEntry" }
```
<!-- tile: x=7 y=1 w=6 h=4 -->
```kzx-chart
{ "version": 1, "kind": "line", "collection": "Sleep", "dateFilter": "thisEntry" }
```
  • <!-- grid: Today --> starts the Dashboard property called “Today”.
  • <!-- tile: x=1 y=1 w=6 h=4 --> starts a tile: its place (column x, row y) and its size (w columns wide, h rows high).
  • A data block (Chart, View, Entry, HTML) is a code block whose language is kzx-chart, kzx-view, kzx-entry or kzx-html, with its settings as JSON. Obsidian shows it as code, and nothing is lost.
  • Writing and media blocks in a tile are plain markdown.
  • Renaming a Dashboard property rewrites its marker.
  • A missing or broken marker goes to problems.md. No block is ever lost.

How the AI, formulas and search read a Dashboard is not decided yet.