# SDK: Canvases

> A canvas lays a project's work out to be seen together: items side by side, with notes, groups and edges. It draws nothing of its own and exports nothing. It is a .canvas file anywhere in the project, in JSON Canvas 1.0 as Obsidian writes it, listed in allyhub.yaml with no kind (- file: boards/launch.canvas, project.md): its editor opens it by its name.

Source: https://allyhub.com/docs/reference/sdk/canvas · AllyHub 0.10.0
Index of all docs: https://allyhub.com/llms.txt

<!-- prettier-ignore -->
```json
{
	"nodes":[
		{"id":"7d1f0c3a9b2e4f60","type":"group","label":"Share pictures","x":-40,"y":-80,"width":1360,"height":520},
		{"id":"2b9e81c04d7f3a15","type":"file","file":"launch/og/og.ts","x":0,"y":0,"width":600,"height":340},
		{"id":"c04d7f3a152b9e81","type":"text","text":"**Why this plate**: the river reads at 400 px.","x":640,"y":0,"width":320,"height":160,"color":"4"},
		{"id":"9a6e2f10b3c84d57","type":"link","url":"https://example.com/launch","x":640,"y":200,"width":320,"height":120}
	],
	"edges":[
		{"id":"5e3a9c1d7b0f2846","fromNode":"c04d7f3a152b9e81","fromSide":"left","toNode":"2b9e81c04d7f3a15","toSide":"right","label":"chosen"}
	]
}
```

- **Paths are from the project's folder**, wherever the canvas is.
- **A file node points at an item by its file**, as `allyhub.yaml` lists it (`launch/og/og.ts`); it shows the item's own preview, live: an image's boards, a deck's slide, a video's still, a doc's first words. Any other file (a picture, a clip, a sound) shows itself.
- **Nodes**: `text` (Markdown), `file`, `link` (`url`) and `group` (`label`), each with whole-pixel `x`, `y`, `width` and `height`; y grows down. The first node is drawn at the back, so a group comes before what it holds. A group holds the nodes whose boxes are inside its box.
- **Edges** join two nodes by id, from a side (`top`, `right`, `bottom`, `left`) to a side, with a `label`; `toEnd` is an arrow unless `"none"`.
- **Colours** are `"1"` red, `"2"` orange, `"3"` yellow, `"4"` green, `"5"` cyan, `"6"` purple, or a hex colour.
- **Ids** are unique across nodes and edges: 16 hex digits, as Obsidian makes them.
- **A person's changes** (moves, notes, edges) are written to the same file, which keeps the ids and the fields it does not know.

`allyhub check` reports a duplicate id, a file node at a missing file and an edge at a missing node (AK-C001 to AK-C004). `allyhub inspect canvas <file>` lists the nodes with their boxes and what they point at, what each group holds and each edge's ends.
