Skip to content

GraphPluginInstanceOptions

Unofficial

User-configurable options for the graph plugin, persisted in graph.json.

Import:

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

Signature:

export interface GraphPluginInstanceOptions

Properties

PropertyTypeDescription
'centerStrength'?numberStrength of the centering force pulling nodes toward the graph center.
'close'?booleanWhether the graph settings panel is closed.
'collapse-color-groups'?booleanWhether the color groups section is collapsed in the settings panel.
'collapse-display'?booleanWhether the display section is collapsed in the settings panel.
'collapse-filter'?booleanWhether the filter section is collapsed in the settings panel.
'collapse-forces'?booleanWhether the forces section is collapsed in the settings panel.
'colorGroups'?GraphColorGroup[]User-defined color groups for visually grouping nodes by search query.
'hideUnresolved'?booleanWhether to hide unresolved (non-existing) linked notes from the graph.
'lineSizeMultiplier'?numberMultiplier for the thickness of link lines.
'linkDistance'?numberIdeal distance between linked nodes in the force simulation.
'linkStrength'?numberStrength of the attractive force between linked nodes.
'localBacklinks'?booleanWhether to show backlinks in the local graph.
'localForelinks'?booleanWhether to show forward links in the local graph.
'localInterlinks'?booleanWhether to show links between neighbor nodes in the local graph.
'localJumps'?numberNumber of link hops to traverse from the current note in the local graph.
'nodeSizeMultiplier'?numberMultiplier for the size of nodes.
'repelStrength'?numberStrength of the repulsive force pushing nodes apart.
'scale'?numberZoom scale level of the graph view.
'search'?stringSearch query used to filter which files appear in the graph.
'showArrow'?booleanWhether to display directional arrows on links.
'showAttachments'?booleanWhether to display attachment files in the graph.
'showOrphans'?booleanWhether to display orphan notes (notes with no links) in the graph.
'showTags'?booleanWhether to display tags as nodes in the graph.
'textFadeMultiplier'?numberMultiplier controlling the distance at which node labels begin to fade.

Links to this page: