quartz-community/quartz
1
0
Fork 0
mirror of https://github.com/jackyzha0/quartz.git synced 2026-07-22 03:00:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
quartz/docs/plugins/Graph.md
saberzero1 05b79e1d60
docs: add missing options to component and page type plugin documentation 
- Graph: add focusOnHover and numeric defaults for all D3Config options
- Search: add enablePreview and fieldPriority options
- TableOfContents: add layout component option
- FolderPage: add showFolderCount and showSubfolders options
- TagPage: add numPages option
- BasesPage: add linkResolution option
2026-05-22 20:07:48 +02:00

2.4 KiB
Raw Blame History

title tags image
Graph
plugin/component

Interactive graph visualization.

Note

For information on how to add, remove or configure plugins, see the configuration#Plugins page.

See graph view for detailed usage information.

Configuration

This plugin accepts the following configuration options:

  • localGraph: Options for the local graph view.
  • globalGraph: Options for the global graph view.

Both localGraph and globalGraph accept the following options:

  • drag: Enable dragging nodes. Defaults to true.
  • zoom: Enable zooming. Defaults to true.
  • depth: The depth of the graph. Defaults to 1 for local and -1 for global.
  • scale: The initial scale of the graph. Defaults to 1.1 for local and 0.9 for global.
  • repelForce: The force that pushes nodes apart. Defaults to 0.5.
  • centerForce: The force that pulls nodes to the center. Defaults to 0.3 for local and 0.2 for global.
  • linkDistance: The distance between linked nodes. Defaults to 30.
  • fontSize: The font size of node labels. Defaults to 0.6.
  • opacityScale: The scale of node opacity. Defaults to 1.
  • removeTags: Tags to exclude from the graph. Defaults to [].
  • showTags: Whether to show tags in the graph. Defaults to true.
  • enableRadial: Whether to enable radial layout. Defaults to false for local and true for global.
  • focusOnHover: Whether to focus on the hovered node. Defaults to false for local and true for global.

Default options

- source: github:quartz-community/graph
  enabled: true
  options:
    localGraph:
      drag: true
      zoom: true
      depth: 1
      scale: 1.1
      repelForce: 0.5
      centerForce: 0.3
      linkDistance: 30
      fontSize: 0.6
      opacityScale: 1
      removeTags: []
      showTags: true
      focusOnHover: false
      enableRadial: false
    globalGraph:
      drag: true
      zoom: true
      depth: -1
      scale: 0.9
      repelForce: 0.5
      centerForce: 0.3
      linkDistance: 30
      fontSize: 0.6
      opacityScale: 1
      removeTags: []
      showTags: true
      focusOnHover: true
      enableRadial: true

API

  • Category: Component
  • Function name: ExternalPlugin.Graph().
  • Source: quartz-community/graph
  • Install: npx quartz plugin add github:quartz-community/graph