Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/redsheep913/Canvas-Card-Materializer/llms.txt

Use this file to discover all available pages before exploring further.

Every file created by Canvas Card-Materializer receives two YAML frontmatter fields that link the note back to its origin on the Canvas. These fields are used internally for Visual Sync and can also be queried with Dataview or other Obsidian plugins.

​
Fields

​
canvas_id
string
required
The unique node ID assigned by Obsidian Canvas to the original text node. This is the string that Canvas uses internally to reference the node in the .canvas JSON file. It is written directly from node.id during Pass 3 of materialization.Example: abc123def456
​
canvas_color
string (numeric string, "0" – "6")
required
The color code of the card at the time of materialization. Used by Visual Sync to restore the card color when the file is dragged back onto a Canvas. The value is coerced to a string via String(node.color) before being stored, and defaults to "0" if the card has no color set.Example: "3" (Yellow)

​
Example Frontmatter Block

---
canvas_id: abc123def456
canvas_color: "3"
---
canvas_color is stored as a string (e.g., "3") even though it corresponds to an integer color code. This matches how Obsidian Canvas stores colors internally, and ensures the value round-trips correctly when Visual Sync reads it back with String(savedColor) to restore the card color.

​
Querying Materialized Notes with Dataview

You can query all materialized notes from a specific Canvas using Dataview:
```dataview
TABLE canvas_color AS "Color", canvas_id AS "Node ID"
FROM ""
WHERE canvas_id != null
```

​
How These Fields Are Written

The plugin uses app.fileManager.processFrontMatter() to write these fields, which means they are written safely without corrupting existing frontmatter. This Obsidian API handles YAML parsing and serialization internally, so any pre-existing fields in the file are preserved untouched.

Build docs developers (and LLMs) love

Get started for freeTalk to us