Skip to content

CanvasPluginInstanceOptions

Unofficial

User-configurable options for the Canvas plugin.

Import:

import type { CanvasPluginInstanceOptions } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface CanvasPluginInstanceOptions

Properties

Property Type Description
cardLabelVisibility? 'always' | 'hover' | 'never' When to display card labels: always, on hover, or never.
defaultModDragBehavior? 'card' | 'group' | 'media' | 'menu' | 'note' | 'webpage' Default node type created when modifier-dragging onto the canvas.
defaultWheelBehavior? 'pan' | 'zoom' Default mouse wheel behavior: pan or zoom.
newFileFolderPath? string Folder path for newly created files from the canvas.
newFileLocation? 'current' | 'folder' | 'root' Where to create new files: vault root, current folder, or a specified folder.
snapToGrid? boolean Whether nodes snap to the grid when moved.
snapToObjects? boolean Whether nodes snap to other objects when moved.
zoomBreakpoint? number Zoom level threshold for switching rendering detail levels.

Links to this page: