rune-langium / visual-editor/src / RuneTypeGraphRef

Interface: RuneTypeGraphRef

Defined in: packages/visual-editor/src/types.ts:525

Imperative ref handle for RuneTypeGraph.

Remarks

Obtain via React.useRef<RuneTypeGraphRef>() and pass as ref to <RuneTypeGraph ref={ref} />. All methods are synchronous except exportImage().

Pitfalls

• relayout() triggers a full Dagre computation — avoid calling it in rapid succession (e.g., in a useEffect with frequent deps). Batch layout updates with a debounce.
• exportImage() renders the current viewport — hidden nodes (filtered out) will not appear in the export.

Methods

exportImage()

exportImage(format): Promise<Blob>;

Defined in: packages/visual-editor/src/types.ts:532

Parameters

Parameter	Type
format	"svg" | "png"

Returns

Promise<Blob>

---

exportRosetta()

exportRosetta(): Map<string, string>;

Defined in: packages/visual-editor/src/types.ts:533

Returns

Map<string, string>

---

fitView()

fitView(): void;

Defined in: packages/visual-editor/src/types.ts:526

Returns

void

---

focusNode()

focusNode(nodeId): void;

Defined in: packages/visual-editor/src/types.ts:527

Parameters

Parameter	Type
nodeId	string

Returns

void

---

getFilters()

getFilters(): GraphFilters;

Defined in: packages/visual-editor/src/types.ts:530

Returns

GraphFilters

---

getNodeData()

getNodeData(nodeId): AnyGraphNode | null;

Defined in: packages/visual-editor/src/types.ts:535

Get current data for a node by ID (returns null if not found).

Parameters

Parameter	Type
nodeId	string

Returns

AnyGraphNode | null

---

getNodes()

getNodes(): TypeGraphNode[];

Defined in: packages/visual-editor/src/types.ts:537

Get all current nodes (for building availableTypes list).

Returns

TypeGraphNode[]

---

relayout()

relayout(options?): void;

Defined in: packages/visual-editor/src/types.ts:531

Parameters

Parameter	Type
options?	LayoutOptions

Returns

void

---

search()

search(query): string[];

Defined in: packages/visual-editor/src/types.ts:528

Parameters

Parameter	Type
query	string

Returns

string[]

---

setFilters()

setFilters(filters): void;

Defined in: packages/visual-editor/src/types.ts:529

Parameters

Parameter	Type
filters	GraphFilters

Returns

void

---

validate()

validate(): ValidationError[];

Defined in: packages/visual-editor/src/types.ts:539

Validate the current graph and return errors.

Returns

ValidationError[]