Interface ReadCanvasResult

Full canvas read result returned by readCanvas.

broken_file_refs lists file: node targets that didn't resolve against the live vault index — the canvas equivalent of getUnresolvedWikilinks.

interface ReadCanvasResult {
    broken_file_refs: string[];
    edges: CanvasEdge[];
    mtime: string;
    name: string;
    nodes: CanvasNode[];
    path: string;
    size_bytes: number;
    summary: {
        file: number;
        group: number;
        link: number;
        text: number;
        unknown: number;
    };
}

Index

Properties

broken_file_refs edges mtime name nodes path size_bytes summary

Properties

broken_file_refs

broken_file_refs: string[]

Embedded files that didn't resolve to anything in the vault — broken canvas references. Empty when all files resolve cleanly.

edges

edges: CanvasEdge[]

mtime

mtime: string

name

name: string

nodes

nodes: CanvasNode[]

path

path: string

size_bytes

size_bytes: number

summary

summary: {
    file: number;
    group: number;
    link: number;
    text: number;
    unknown: number;
}

Convenience summary: # of each node kind.

Interface ReadCanvasResult

Index

Properties

Properties

broken_file_refs

edges

mtime

name

nodes

path

size_bytes

summary

Settings

On This Page