CanvasReference

A reference within a canvas.

Import:

import type { CanvasReference } from 'obsidian-dev-utils/obsidian/reference';

Signature:

export interface CanvasReference extends FrontmatterLinkCache

Extends: FrontmatterLinkCache

Properties

Property	Type	Description
isCanvas	true	Whether the reference is a canvas reference.
nodeIndex	number	An index of the node in the canvas.
type	'file' | 'text'	A type of reference.

---

Links to this page:

• CanvasFileNodeReference
• CanvasTextNodeReference