quartz/docs/plugins/Graph.md

2.5 KiB

title description tags image repository enabled required
Graph Interactive link graph visualization.
plugin/component
[quartz-community/graph](https://github.com/quartz-community/graph) true false

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