Bases Link Graph

by theluckystrike
5
4
3
2
1
Score: 50/100

Description

Draws the notes that a base selects as an interactive graph. Links become edges, and you click a node to open its note.

Reviews

No reviews yet.

Stats

1
stars
659
downloads
0
forks
40
days
4
days
4
days
1
total PRs
0
open PRs
0
closed PRs
1
merged PRs
0
total issues
0
open issues
0
closed issues
21
commits

Latest Version

5 days ago

Changelog

Patch Changes

  • The Sponsor button now opens the NoteMods one-time tier.

README file from

Github

Bases Link Graph draws the notes that a base selects as a graph. Each note is a node, and each link between two of those notes is an edge.

Pro costs $15 one time or $5 a month: Sponsor or $15 one-time offer.

Quick start

Note A:

See [[B]] and [[C]].

Make B and C. Create a base, or open one. Select the view menu in the base toolbar and add a view of the type "Link graph". Click a node to open its note.

Features

The notes of a base as a graph

With "Show notes without links" on, each row becomes one node. Links to notes outside the base are left out. Notes with more links are larger.

Set "Draw links from" to "All links" (the default), "Note body" (with embeds) or "Properties". Add names such as parent to "Link properties" to select relations. An empty list uses all properties. The filter is saved with each view.

Turn on "Show arrows" to point each link at its target. Hover over a note to see its relations, such as parent → Rose. Body links are body. Pro colors each relation, with a "Links" legend.

Headings and blocks as nodes

Set "Headings and blocks" to "Linked headings and blocks". A link such as [[Book#Repair]] or [[Book#^q1]] then points to a small node on its note. Embeds, aliases and nested headings count. A link to a missing heading goes to the note.

"All headings" shows every heading. A body link starts at the heading that holds it, so an image hangs from its chapter. Click a heading node to open the note there.

Click to open, hover to preview

Click a node to open its note. Ctrl-click (Cmd-click on macOS) opens a new tab. Hover over a node to light up its links. Hold Ctrl or Cmd to preview the note. Scroll to zoom, drag to pan or move a node, and double-click the background to fit the graph.

Trackpad navigation

With "Trackpad navigation" on, a two-finger scroll pans. Pinch, or hold Ctrl or Cmd while scrolling, to zoom.

Live update and embeds

After a link changes, the graph draws again and nodes keep their place. Embed a view with ![[Your base.base#View name]].

Size and color by a property (Pro)

Set "Size by" and "Color by" in the view options. For "Color by", many numbers become five ranges, and past eight values the rest share one "Other" color.

Edges from shared values (Pro)

In "Join notes that share", type property names such as team or tags. A value that more than 12 notes share joins them in a chain.

Local depth (Pro)

Right-click a node and select "Show only notes near this one". The "Local depth" slider sets the depth. The x on the chip above the graph shows all notes again.

Export and saved layouts (Pro)

Use the buttons above the graph or the commands. Exports show the whole graph with labels, and SVG also has the legend. "Reset layout" removes a saved layout.

Install

  1. Open "Settings → Community plugins", select "Browse" and search for "Bases Link Graph".
  2. Select "Install" and "Enable". The core plugin "Bases" must be on.

For manual installation, copy the release files into <vault>/.obsidian/plugins/bases-link-graph/ and enable the plugin. You need Obsidian 1.13.4 or later.

Usage

  1. Create a base, or open one. Set its filters to select the notes you want to see.
  2. Select the view menu in the base toolbar and add a view of the type "Link graph".
  3. Open the view options to set labels, links and headings.

The base limit applies: when the base shows the first 100 results, the graph has 100 nodes.

Pro

The command "What Pro adds" shows each with a demo.

  • Size by: the node size shows the value of a number property.
  • Color by: the node color shows the value of a property, with a legend.
  • Color links by relation: each relation gets its own color, with a Links legend.
  • Headings hang from their parent heading, and you can hide the headings below a level.

More Pro tools:

  • Notes that share a property value get a dashed edge.
  • Local depth shows only the notes up to 1 to 5 links away from one note.
  • Export the graph to a PNG or an SVG file.
  • Save the positions of the nodes in the base file.

Sponsor $5 a month, or $15 once. When you have paid $15 in total, Pro stays on.

The free version has no note limit. To get Pro:

  1. Sponsor through GitHub Sponsors. A total payment of $15 meets the payment requirement for Pro without further payment. Sign-in and the checks below still apply.
  2. In Obsidian, open the settings of Bases Link Graph and select "Sign in with GitHub".
  3. Paste the copied code at github.com/login/device and approve.

When Pro is off, the Pro options stay saved in the base file and the graph ignores them.

Settings

After a minor or major update, this plugin opens one What's new tab in the background. The tab and settings card suggest other NoteMods plugins and Zovo Chat and link to notemods.com for feedback (privacy). The tab sends no data. Turn the tab off in Settings.

View options (base toolbar, saved in the base file):

Option What it does
Labels When zoomed in, always, or on hover only.
Show notes without links Shows or hides notes with no edge.
Draw links from All links, Note body, or Properties.
Link properties Names of link properties. Empty uses all. Applies only to Properties.
Show arrows Arrowheads at link targets.
Headings and blocks Off, Linked headings and blocks, or All headings.
Link length Distance between linked notes, 20 to 200.
Size by (Pro) A number property for the node size.
Color by (Pro) A property for the node color, with a legend.
Join notes that share (Pro) Property names whose shared values add dashed edges.
Local depth (Pro) How many edges away from the chosen note to show, 0 to 5.
Color links by relation (Pro) A color for each relation, with a "Links" legend.
Nest headings under their parent heading (Pro) A heading hangs from its parent heading.
Deepest heading level (Pro) Hides headings below this level, 1 to 6.

The settings tab also has "Animate the layout" (on), "Trackpad navigation" (off) and "Live update delay" (100 to 2000 ms, 400 ms).

FAQ

How is this different from the core graph view?

The core graph shows the vault or one note. Bases Link Graph uses the filters of a base.

How fast is it?

A test draws 500 notes and 1,490 links and needs a layout warm-up under 400 ms and frames under 50 ms on average. We have not measured phones or tablets.

Does it change my notes?

No. Saved layouts and view options go in the base file. Export creates a new file.

Payment, account and network

The core features are free. Pro features need a GitHub Sponsors sponsorship of theluckystrike: $5 a month or more, or $15 once. A total payment of $15 meets the payment requirement for Pro without further payment. Sign-in and the checks below still apply. Your notes stay readable and editable with or without Pro.

One payment turns on Pro in every NoteMods plugin.

GitHub handles the payment. Sponsor at https://github.com/sponsors/theluckystrike?frequency=one-time&metadata_source=bases-link-graph. You need no account for the free features. Pro needs the GitHub account that sponsors.

Until you select "Sign in with GitHub" in the settings, Bases Link Graph makes no network requests. Sign in uses the GitHub device flow. Bases Link Graph sends its public client ID and the scope read:user to https://github.com/login/device/code and shows you a code. While you enter the code at https://github.com/login/device, it asks https://github.com/login/oauth/access_token every few seconds to check the sign-in status. The scope permits profile reads only. GitHub needs this access to show the sponsorship tier. It grants no repository scope and no write access.

After sign in, Bases Link Graph sends one query to https://api.github.com/graphql. It checks if the signed-in account sponsors theluckystrike. It asks for the tier and the total payment to theluckystrike. The plugin reuses a successful check for 7 days. Failed checks can retry after 6 hours. Select Refresh to request an earlier check. It sends no note content, file names or other vault data, and it has no telemetry.

After a successful check, Pro can work offline for up to 14 days. Sign out or a negative sponsorship answer turns Pro off. The plugin stores the GitHub token through the secret storage API of Obsidian. It does not put the token in its saved settings or its local sponsorship data. The local storage of this device keeps your GitHub login, the tier and the time of the last check. Sign out clears the token. You can also revoke the access in your GitHub settings, under Applications.

Support

Plugin page: bases-link-graph.

Report bugs in the issues, with your Obsidian version and a sample base if you can.

Community

Questions, bugs or plugin ideas? Talk to me and other Obsidian users in Zovo Chat on Telegram. It has a topic for these plugins. You can also open an issue here.