Graph View
Summary
The graph view lets you explore your workspace using a graph
Features
- Click on a node to open up the corresponding note/schema in your workspace.
- Hover over a node to see its full name
- Filter graph view to show only desired data
Types
Note Graph
Full Note Graph
Show graph of all your notes. You can activate this by using the Show Note Graph Command command and toggling the Show Note Graph option.
Local Note Graph
Shows a graph of your current note and immediate neighbors. This is the default view when you run Show Note Graph.
Schema Graph
Show graph of your schemas. You can activate by running the Show Schema Graph command.
Commands
Show Note Graph
Launch the command palette (see docs): > Dendron: Show Note Graph
Click on a node to open up the corresponding note in your workspace, or open a note to center the graph on that note.
Use the filter view in the top left to filter and modify the data shown by the graph.
Show Schema Graph
Launch the command palette (see docs): > Dendron: Show Schema Graph
Click on a node to open up the corresponding schema in your workspace.
Use the filter view in the top left to filter and modify the data shown by the graph.
The schema graph shows high level connections between a vault's root
schema and other schemas within the vault. These other schemas may have other nodes connected to them representing additional children of that schema.
Filter View
In the top left of both the note and schema graphs lives the graph filter view. This UI element contains information about the graph and various filtering options.
Vaults
This view contains a list of each vault in the workspace. The visibility of each vault in the graph can be toggled to better filter the graph.
Connections
- Hierarchy: When checked, include hierarchical graph connections
- Links: When checked, include linked note connections
Filter
This view contains various options to filter the graph.
String Filters
Use these string filters to include/exclude graph nodes by filename or name. These fields support multiple arguments in the form of a comma-separated or space-separated list.
- Allowlist: Graph nodes including any of these string arguments will be included in the graph
- Blocklist: Graph nodes including any of these string arguments will be excluded from the graph
Here's a quick example:
- Allow:
journal.2021, dog
- Include any notes that include either
journal.2021
ordog
in their name or filename
- Include any notes that include either
- Block:
cat
- Exclude any notes with
cat
in their name or filename
- Exclude any notes with
Other Filters
- Show Stubs: When checked, show stub notes in the graph
- Depth: In a local graph view, the depth filter allows you to see the second or third degree of nodes from the active note. See video here.
Options
-
Show Local Graph (Note Only): When checked, show local graph centered around the current open note. Otherwise, show the full workspace-wide note graph.
-
Allow Relayout: When checked, layout the graph again when the graph configuration is updated.
- This is useful in instances you'd like to preserve the current layout but add/remove information, e.g. adding link connections to a hierarchical graph while maintaining readability
Information
Primarily for debugging, this section has information about graph size. Edge counts are calculated individually from the actual rendered edges, so may not represent the true rendered count if a certain type of edge is hidden.
- Linked Edges: Number of linked connections between nodes
- Hierarchical Edges: Number of hierarchical connections between nodes
- Nodes: Number of nodes in the graph
Graph Theme
This view contains a list of available Graph Themes. Presently, Dendron provides three built-in graph themes:
- Block
- Classic
- Monokai
This list also appends Custom
if custom graph stylings are provided.
To create your own Custom Styling for Graph, click on the Create Your Own
button next to the themes or by running > Dendron: Configure Graph Style (css)
. You can view the example video here.
If you are new to cytoscape styling, use Built-in Snippet provided by Dendron to help you get started.
Config
Graph configuration is nested under the graph
object.
See example below
graph:
zoomSpeed: 1 # The speed at which the graph zooms in and out. Lower is slower, higher is faster.
createStub: false # When enabled, creates a note if it hasn't been created already when clicked on a graph node
Zoom Speed
- type: number
- default: 1
The speed at which the graph zooms in and out. Lower is slower, higher is faster.
Create Stub
- type: boolean
- default: false
When enabled, creates a note if it hasn't been created already when clicked on a graph node.
Custom Styling
Dendron supports custom styling of schema and note graphs. Styling follows the Cytoscape.js format, which is CSS-like with a couple of differences. Full Cytoscape.js styling documentation can be found here.
Adding Styles
Launch the command palette (see docs): > Dendron: Configure Graph Style (css)
Once the styles.css
file is open, add your styles and save. The styles will be visible in the graph the next time it is opened.
If you're migrating from Obsidian, see Obsidian Style.
Selectors
In order to style the graph, there are a variety of selectors to choose from. Currently supported selectors include:
Selector | Description |
---|---|
node | Any node |
edge | Any edge |
:selected | Any selected node |
.parent | Any parent node (local note graph only) |
.links | Any link connection edge |
.hierarchy | Any hierarchy connection edge |
There are also some vault-specific selectors. These include:
Selector | Description |
---|---|
.vault-VAULT_NAME | Any node or edge in the VAULT_NAME vault |
Selectors can be chained together, just like in regular CSS. For example, node.vault-VAULT_NAME
would target only nodes in the VAULT_NAME
vault.
Style Properties
Styling Nodes
Some common node style properties are listed below. Full node style property list →
Property | Description |
---|---|
width | The width of the node’s body. |
height | The height of the node’s body. |
shape | The shape of the node's body (ellipse, triangle, etc.) |
background-color | The color of the node's body. |
border-width | The size of the node’s border. |
border-color | The color of the node’s border. |
Styling Node Labels
Some common node label style properties are listed below. Select labels by selecting the node associated with them. Full node label style property list →
Property | Description |
---|---|
color | The color of the label. |
font-size | The size of the label text. |
font-weight | The font weight of the label text. |
Styling Edges
Some common edge style properties are listed below. Full edge style property list →
Property | Description |
---|---|
width | The width of the edge line. |
line-color | The color of the edge line. |
line-style | The style of the edge line (solid , dotted , or dashed ). |
Built-in Snippet
Use these snippets as a starting point for curating custom styles for graph.
- Monokai Theme
/* Any graph node */
node {
color: #ff6188;
font-family: cursive;
}
/* Any graph edge */
edge {
width: 0.5;
line-color: #78dce8;
target-distance-from-node: 5;
source-distance-from-node: 5;
source-endpoint: outside-to-line-or-label;
target-endpoint: outside-to-line-or-label;
}
/* Any selected node */
:selected {
color: #fc9867;
}
/** AC2065 **/
/* Any parent nodes (local note graph only) */
.parent {
color: #a9dc76;
}
/* Any link connection edge */
.links {
curve-style: bezier;
}
/* Any hierarchy connection edge */
.hierarchy {
curve-style: bezier;
}
- Block Theme
/* Any graph node */
node {
background-color: #bb86fc;
color: #bb86fc;
}
edge {
line-color: #b591d9;
target-distance-from-node: 5;
source-distance-from-node: 5;
}
/* Any selected node */
:selected {
background-color: #c7fc86;
color: #c7fc86;
}
/* Any parent nodes (local note graph only) */
.parent {
color: coral;
background-color: coral;
}
/* Any link connection edge */
.links {
curve-style: unbundled-bezier;
}
/* Any hierarchy connection edge */
.hierarchy {
curve-style: taxi;
}
Troubleshooting
If styles are not showing up in the graph, try the following steps:
- Check that every style property ends in a semi-colon.
- Check that you have no unused selectors (e.g.
node {}
). Cytoscape can be a bit particular at times, so just comment out selectors if not in use. - Close and re-open the graph view. Styles only apply on graph open at the moment.
RFCs
Backlinks