GraphPluginInstanceOptions
Unofficial
User-configurable options for the graph plugin, persisted in graph.json.
Import:
import type { GraphPluginInstanceOptions } from '@obsidian-typings/obsidian-public-latest';Signature:
export interface GraphPluginInstanceOptionsProperties
| Property | Type | Description | |
|---|---|---|---|
| 'centerStrength'? | number | Strength of the centering force pulling nodes toward the graph center. | |
| 'close'? | boolean | Whether the graph settings panel is closed. | |
| 'collapse-color-groups'? | boolean | Whether the color groups section is collapsed in the settings panel. | |
| 'collapse-display'? | boolean | Whether the display section is collapsed in the settings panel. | |
| 'collapse-filter'? | boolean | Whether the filter section is collapsed in the settings panel. | |
| 'collapse-forces'? | boolean | Whether the forces section is collapsed in the settings panel. | |
| 'colorGroups'? | GraphColorGroup[] | User-defined color groups for visually grouping nodes by search query. | |
| 'hideUnresolved'? | boolean | Whether to hide unresolved (non-existing) linked notes from the graph. | |
| 'lineSizeMultiplier'? | number | Multiplier for the thickness of link lines. | |
| 'linkDistance'? | number | Ideal distance between linked nodes in the force simulation. | |
| 'linkStrength'? | number | Strength of the attractive force between linked nodes. | |
| 'localBacklinks'? | boolean | Whether to show backlinks in the local graph. | |
| 'localForelinks'? | boolean | Whether to show forward links in the local graph. | |
| 'localInterlinks'? | boolean | Whether to show links between neighbor nodes in the local graph. | |
| 'localJumps'? | number | Number of link hops to traverse from the current note in the local graph. | |
| 'nodeSizeMultiplier'? | number | Multiplier for the size of nodes. | |
| 'repelStrength'? | number | Strength of the repulsive force pushing nodes apart. | |
| 'scale'? | number | Zoom scale level of the graph view. | |
| 'search'? | string | Search query used to filter which files appear in the graph. | |
| 'showArrow'? | boolean | Whether to display directional arrows on links. | |
| 'showAttachments'? | boolean | Whether to display attachment files in the graph. | |
| 'showOrphans'? | boolean | Whether to display orphan notes (notes with no links) in the graph. | |
| 'showTags'? | boolean | Whether to display tags as nodes in the graph. | |
| 'textFadeMultiplier'? | number | Multiplier controlling the distance at which node labels begin to fade. |
Links to this page: