GraphEngine

Unofficial

Engine of a graph view.

Import:

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

Signature:

export interface GraphEngine

Properties

Property	Type	Description
app	App	Reference to the Obsidian app instance.
colorGroupOptions	GraphColorGroupOptions	UI controls for configuring color group options.
controlsEl	HTMLDivElement	Container element for the graph settings controls panel.
currentFocusFile	string	Path of the currently focused file in the local graph.
displayOptions	GraphDisplayOptions	UI controls for configuring display options.
fileFilter	GraphFileFilter	Filter determining which files are included in the graph.
filterOptions	GraphFilterOptions	UI controls for configuring filter options.
forceOptions	GraphForceOptions	UI controls for configuring force simulation options.
hasFilter	boolean	Whether any search filter is currently active.
hoverPopover	unknown	Hover popover displayed when hovering over a node.
lastHoverLink	unknown	Last link that was hovered over.
options	GraphPluginInstanceOptions	Current graph plugin options applied to this engine.
progression	number	Current animation progression value for graph transitions.
progressionSpeed	number	Speed of the animation progression.
renderer	GraphRenderer	Renderer responsible for drawing the graph.
searchQueries	GraphColorGroup[]	Active color group search queries for node coloring.
view	GraphView \| LocalGraphView	The view (local or global) that owns this engine.

Method	Returns	Description
getOptions()	GraphPluginInstanceOptions	Gets the engine options.
render()	void	Rerenders the graph.
setOptions(options)	void	Sets the engine options.
updateSearch()	void	Updates the engine after the search filter has changed.

Links to this page: