Skip to content

CanvasViewCanvasNodeBaseBaseBase

Unofficial

Lowest-level base interface for canvas nodes, providing core properties and interaction methods.

Import:

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

Signature:

export interface CanvasViewCanvasNodeBaseBaseBase

Properties

PropertyTypeDescription
isAttached?unknownWhether the node is currently attached to the canvas DOM.
isFocused?unknownWhether the node currently has focus.
rectCanvasRectBounding rectangle of the node.

Methods

MethodReturnsDescription
attach()unknownAttach the node to the canvas DOM.
blur()unknownRemove focus from the node.
deselect()unknownDeselect the node.
destroy()unknownDestroy the node and release its resources.
detach()unknownDetach the node from the canvas DOM.
focus()unknownSet focus on the node.
getBBox()unknownGet the bounding box of the node.
getConnectedFiles()unknownGet all files connected to this node via edges.
getData()unknownGet the serialized data for this node.
initialize()unknownInitialize the node after construction.
isEditable()unknownCheck whether this node supports editing.
moveAndResize(arg1)unknownMove and resize the node to the specified bounds.
moveTo(arg1)unknownMove the node to the specified position.
onClick(arg1)unknownHandle click events on the node.
onConnectionPointerdown(arg1, arg2)unknownHandle pointer down on a connection handle to start edge creation.
onContextMenu(arg1)unknownHandle context menu events on the node.
onPointerdown(arg1)unknownHandle pointer down events on the node.
onResizeDblclick(arg1, arg2)unknownHandle double-click on a resize handle to auto-size the node.
onResizePointerdown(arg1, arg2)unknownHandle pointer down on a resize handle to start resizing.
preDetach()unknownPerform cleanup before detaching the node.
render()unknownRender the node to the canvas.
renderZIndex()unknownRender the node's z-index CSS property.
resize(arg1)unknownResize the node to the specified dimensions.
select()unknownMark the node as selected.
setColor(arg1, arg2)unknownSet the color of the node.
setData(arg1)unknownSet the serialized data for this node.
setIsEditing(arg1)unknownSet whether the node is in editing mode.
showMenu(arg1)unknownShow the context menu for this node.
startEditing()unknownEnter editing mode for the node's content.
updateBreakpoint(arg1)unknownUpdate the rendering breakpoint based on the node's current size.
updateZIndex()unknownUpdate the z-index of the node in the stacking order.

Links to this page: