Skip to content

GraphLink

Unofficial

Represents a link in a graph view.

Import:

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

Signature:

export interface GraphLink

Properties

Property Type Description
arrow Graphics | null PixiJS element for the arrow, child of GraphRenderer.hanger.
line null | Sprite PixiJS element for the line.
px Container | null Parent of GraphLink.line, child of GraphRenderer.hanger.
rendered boolean Whether the link graphics have been rendered.
renderer GraphRenderer GraphRenderer managing this node.
source GraphNode Source node of the link.
target GraphNode Target node of the link.

Methods

Method Returns Description
clearGraphics() void Destroy the graphics and its children, and remove them from the scene.
initGraphics() void Initialize the link (line and arrow), and add them to the scene.
render() void Render the link.

Links to this page: