From 14cbbdb8a2f69ebc51cd53a82b50206c543778b0 Mon Sep 17 00:00:00 2001
From: Oskar Manhart <52569953+oskardotglobal@users.noreply.github.com>
Date: Thu, 14 Sep 2023 03:55:59 +0000
Subject: [PATCH] feat: display tag in graph view (#466)
---
quartz/components/scripts/graph.inline.ts | 133 +++++++++++++++++++++++++------------------
1 files changed, 77 insertions(+), 56 deletions(-)
diff --git a/quartz/components/scripts/graph.inline.ts b/quartz/components/scripts/graph.inline.ts
index 1556095..1aff138 100644
--- a/quartz/components/scripts/graph.inline.ts
+++ b/quartz/components/scripts/graph.inline.ts
@@ -1,30 +1,32 @@
-import { ContentDetails } from "../../plugins/emitters/contentIndex"
-import * as d3 from 'd3'
-import { registerEscapeHandler, relative, removeAllChildren } from "./util"
+import type { ContentDetails } from "../../plugins/emitters/contentIndex"
+import * as d3 from "d3"
+import { registerEscapeHandler, removeAllChildren } from "./util"
+import { FullSlug, SimpleSlug, getFullSlug, resolveRelative, simplifySlug } from "../../util/path"
type NodeData = {
- id: string,
- text: string,
+ id: SimpleSlug
+ text: string
tags: string[]
} & d3.SimulationNodeDatum
type LinkData = {
- source: string,
- target: string
+ source: SimpleSlug
+ target: SimpleSlug
}
const localStorageKey = "graph-visited"
-function getVisited(): Set<string> {
+function getVisited(): Set<SimpleSlug> {
return new Set(JSON.parse(localStorage.getItem(localStorageKey) ?? "[]"))
}
-function addToVisited(slug: string) {
+function addToVisited(slug: SimpleSlug) {
const visited = getVisited()
visited.add(slug)
localStorage.setItem(localStorageKey, JSON.stringify([...visited]))
}
-async function renderGraph(container: string, slug: string) {
+async function renderGraph(container: string, fullSlug: FullSlug) {
+ const slug = simplifySlug(fullSlug)
const visited = getVisited()
const graph = document.getElementById(container)
if (!graph) return
@@ -39,45 +41,72 @@
centerForce,
linkDistance,
fontSize,
- opacityScale
+ opacityScale,
+ removeTags,
+ showTags,
} = JSON.parse(graph.dataset["cfg"]!)
const data = await fetchData
const links: LinkData[] = []
+ const tags: SimpleSlug[] = []
+
+ const validLinks = new Set(Object.keys(data).map((slug) => simplifySlug(slug as FullSlug)))
+
for (const [src, details] of Object.entries<ContentDetails>(data)) {
+ const source = simplifySlug(src as FullSlug)
const outgoing = details.links ?? []
+
for (const dest of outgoing) {
- if (src in data && dest in data) {
- links.push({ source: src, target: dest })
+ if (validLinks.has(dest)) {
+ links.push({ source, target: dest })
+ }
+ }
+
+ if (showTags) {
+ const localTags = details.tags
+ .filter((tag) => !removeTags.includes(tag))
+ .map((tag) => simplifySlug(("tags/" + tag) as FullSlug))
+
+ tags.push(...localTags.filter((tag) => !tags.includes(tag)))
+
+ for (const tag of localTags) {
+ links.push({ source, target: tag })
}
}
}
- const neighbourhood = new Set()
-
- const wl = [slug, "__SENTINEL"]
+ const neighbourhood = new Set<SimpleSlug>()
+ const wl: (SimpleSlug | "__SENTINEL")[] = [slug, "__SENTINEL"]
if (depth >= 0) {
while (depth >= 0 && wl.length > 0) {
// compute neighbours
- const cur = wl.shift()
+ const cur = wl.shift()!
if (cur === "__SENTINEL") {
depth--
wl.push("__SENTINEL")
} else {
neighbourhood.add(cur)
- const outgoing = links.filter(l => l.source === cur)
- const incoming = links.filter(l => l.target === cur)
+ const outgoing = links.filter((l) => l.source === cur)
+ const incoming = links.filter((l) => l.target === cur)
wl.push(...outgoing.map((l) => l.target), ...incoming.map((l) => l.source))
}
}
} else {
- Object.keys(data).forEach(id => neighbourhood.add(id))
+ Object.keys(data).forEach((id) => neighbourhood.add(simplifySlug(id as FullSlug)))
+ if (showTags) tags.forEach((tag) => neighbourhood.add(tag))
}
- const graphData: { nodes: NodeData[], links: LinkData[] } = {
- nodes: Object.keys(data).filter(id => neighbourhood.has(id)).map(url => ({ id: url, text: data[url]?.title ?? url, tags: data[url]?.tags ?? [] })),
- links: links.filter((l) => neighbourhood.has(l.source) && neighbourhood.has(l.target))
+ const graphData: { nodes: NodeData[]; links: LinkData[] } = {
+ nodes: [...neighbourhood].map((url) => {
+ const text = url.startsWith("tags/") ? "#" + url.substring(5) : data[url]?.title ?? url
+ return {
+ id: url,
+ text: text,
+ tags: data[url]?.tags ?? [],
+ }
+ }),
+ links: links.filter((l) => neighbourhood.has(l.source) && neighbourhood.has(l.target)),
}
const simulation: d3.Simulation<NodeData, LinkData> = d3
@@ -96,11 +125,11 @@
const width = graph.offsetWidth
const svg = d3
- .select<HTMLElement, NodeData>('#' + container)
+ .select<HTMLElement, NodeData>("#" + container)
.append("svg")
.attr("width", width)
.attr("height", height)
- .attr('viewBox', [-width / 2 / scale, -height / 2 / scale, width / scale, height / scale])
+ .attr("viewBox", [-width / 2 / scale, -height / 2 / scale, width / scale, height / scale])
// draw links between nodes
const link = svg
@@ -120,7 +149,7 @@
const isCurrent = d.id === slug
if (isCurrent) {
return "var(--secondary)"
- } else if (visited.has(d.id)) {
+ } else if (visited.has(d.id) || d.id.startsWith("tags/")) {
return "var(--tertiary)"
} else {
return "var(--gray)"
@@ -145,7 +174,7 @@
d.fy = null
}
- const noop = () => { }
+ const noop = () => {}
return d3
.drag<Element, NodeData>()
.on("start", enableDrag ? dragstarted : noop)
@@ -167,12 +196,14 @@
.attr("fill", color)
.style("cursor", "pointer")
.on("click", (_, d) => {
- const targ = relative(slug, d.id)
- window.spaNavigate(new URL(targ))
+ const targ = resolveRelative(fullSlug, d.id)
+ window.spaNavigate(new URL(targ, window.location.toString()))
})
- .on("mouseover", function(_, d) {
- const neighbours: string[] = data[slug].links ?? []
- const neighbourNodes = d3.selectAll<HTMLElement, NodeData>(".node").filter((d) => neighbours.includes(d.id))
+ .on("mouseover", function (_, d) {
+ const neighbours: SimpleSlug[] = data[fullSlug].links ?? []
+ const neighbourNodes = d3
+ .selectAll<HTMLElement, NodeData>(".node")
+ .filter((d) => neighbours.includes(d.id))
const currentId = d.id
const linkNodes = d3
.selectAll(".link")
@@ -182,12 +213,7 @@
neighbourNodes.transition().duration(200).attr("fill", color)
// highlight links
- linkNodes
- .transition()
- .duration(200)
- .attr("stroke", "var(--gray)")
- .attr("stroke-width", 1)
-
+ linkNodes.transition().duration(200).attr("stroke", "var(--gray)").attr("stroke-width", 1)
const bigFont = fontSize * 1.5
@@ -198,11 +224,11 @@
.select("text")
.transition()
.duration(200)
- .attr('opacityOld', d3.select(parent).select('text').style("opacity"))
- .style('opacity', 1)
- .style('font-size', bigFont + 'em')
+ .attr("opacityOld", d3.select(parent).select("text").style("opacity"))
+ .style("opacity", 1)
+ .style("font-size", bigFont + "em")
})
- .on("mouseleave", function(_, d) {
+ .on("mouseleave", function (_, d) {
const currentId = d.id
const linkNodes = d3
.selectAll(".link")
@@ -215,8 +241,8 @@
.select("text")
.transition()
.duration(200)
- .style('opacity', d3.select(parent).select('text').attr("opacityOld"))
- .style('font-size', fontSize + 'em')
+ .style("opacity", d3.select(parent).select("text").attr("opacityOld"))
+ .style("font-size", fontSize + "em")
})
// @ts-ignore
.call(drag(simulation))
@@ -227,10 +253,10 @@
.attr("dx", 0)
.attr("dy", (d) => -nodeRadius(d) + "px")
.attr("text-anchor", "middle")
- .text((d) => data[d.id]?.title || (d.id.charAt(1).toUpperCase() + d.id.slice(2)).replace("-", " "))
- .style('opacity', (opacityScale - 1) / 3.75)
+ .text((d) => d.text)
+ .style("opacity", (opacityScale - 1) / 3.75)
.style("pointer-events", "none")
- .style('font-size', fontSize + 'em')
+ .style("font-size", fontSize + "em")
.raise()
// @ts-ignore
.call(drag(simulation))
@@ -248,7 +274,7 @@
.on("zoom", ({ transform }) => {
link.attr("transform", transform)
node.attr("transform", transform)
- const scale = transform.k * opacityScale;
+ const scale = transform.k * opacityScale
const scaledOpacity = Math.max((scale - 1) / 3.75, 0)
labels.attr("transform", transform).style("opacity", scaledOpacity)
}),
@@ -262,17 +288,13 @@
.attr("y1", (d: any) => d.source.y)
.attr("x2", (d: any) => d.target.x)
.attr("y2", (d: any) => d.target.y)
- node
- .attr("cx", (d: any) => d.x)
- .attr("cy", (d: any) => d.y)
- labels
- .attr("x", (d: any) => d.x)
- .attr("y", (d: any) => d.y)
+ node.attr("cx", (d: any) => d.x).attr("cy", (d: any) => d.y)
+ labels.attr("x", (d: any) => d.x).attr("y", (d: any) => d.y)
})
}
function renderGlobalGraph() {
- const slug = document.body.dataset["slug"]!
+ const slug = getFullSlug(window)
const container = document.getElementById("global-graph-outer")
const sidebar = container?.closest(".sidebar") as HTMLElement
container?.classList.add("active")
@@ -304,4 +326,3 @@
containerIcon?.removeEventListener("click", renderGlobalGraph)
containerIcon?.addEventListener("click", renderGlobalGraph)
})
-
--
Gitblit v1.10.0