roadmap/quartz/components/scripts/graph.inline.ts

308 lines
8.9 KiB
TypeScript
Raw Normal View History

2023-07-24 00:58:35 +00:00
import type { ContentDetails } from "../../plugins/emitters/contentIndex"
2023-07-23 00:27:41 +00:00
import * as d3 from "d3"
import { registerEscapeHandler, removeAllChildren } from "./util"
import { FullSlug, SimpleSlug, getFullSlug, resolveRelative, simplifySlug } from "../../util/path"
2023-06-18 17:47:07 +00:00
type NodeData = {
id: SimpleSlug
2023-07-23 00:27:41 +00:00
text: string
2023-06-18 17:47:07 +00:00
tags: string[]
} & d3.SimulationNodeDatum
type LinkData = {
source: SimpleSlug
target: SimpleSlug
2023-06-18 17:47:07 +00:00
}
2023-07-01 07:03:01 +00:00
const localStorageKey = "graph-visited"
function getVisited(): Set<SimpleSlug> {
2023-07-01 07:03:01 +00:00
return new Set(JSON.parse(localStorage.getItem(localStorageKey) ?? "[]"))
}
function addToVisited(slug: SimpleSlug) {
2023-07-01 07:03:01 +00:00
const visited = getVisited()
visited.add(slug)
localStorage.setItem(localStorageKey, JSON.stringify([...visited]))
}
async function renderGraph(container: string, fullSlug: FullSlug) {
const slug = simplifySlug(fullSlug)
2023-07-01 07:03:01 +00:00
const visited = getVisited()
2023-06-20 03:37:45 +00:00
const graph = document.getElementById(container)
if (!graph) return
2023-06-18 17:47:07 +00:00
removeAllChildren(graph)
let {
drag: enableDrag,
zoom: enableZoom,
depth,
scale,
repelForce,
centerForce,
linkDistance,
fontSize,
2023-07-23 00:27:41 +00:00
opacityScale,
2023-06-18 17:47:07 +00:00
} = JSON.parse(graph.dataset["cfg"]!)
const data = await fetchData
const links: LinkData[] = []
for (const [src, details] of Object.entries<ContentDetails>(data)) {
const source = simplifySlug(src as FullSlug)
2023-06-18 17:47:07 +00:00
const outgoing = details.links ?? []
for (const dest of outgoing) {
if (dest in data) {
links.push({ source, target: dest })
2023-06-18 17:47:07 +00:00
}
}
}
const neighbourhood = new Set<SimpleSlug>()
const wl: (SimpleSlug | "__SENTINEL")[] = [slug, "__SENTINEL"]
2023-06-18 17:47:07 +00:00
if (depth >= 0) {
while (depth >= 0 && wl.length > 0) {
// compute neighbours
const cur = wl.shift()!
2023-06-18 17:47:07 +00:00
if (cur === "__SENTINEL") {
depth--
wl.push("__SENTINEL")
} else {
neighbourhood.add(cur)
2023-07-23 00:27:41 +00:00
const outgoing = links.filter((l) => l.source === cur)
const incoming = links.filter((l) => l.target === cur)
2023-06-18 17:47:07 +00:00
wl.push(...outgoing.map((l) => l.target), ...incoming.map((l) => l.source))
}
}
} else {
Object.keys(data).forEach((id) => neighbourhood.add(simplifySlug(id as FullSlug)))
2023-06-18 17:47:07 +00:00
}
2023-07-23 00:27:41 +00:00
const graphData: { nodes: NodeData[]; links: LinkData[] } = {
nodes: [...neighbourhood].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)),
2023-06-18 17:47:07 +00:00
}
const simulation: d3.Simulation<NodeData, LinkData> = d3
.forceSimulation(graphData.nodes)
.force("charge", d3.forceManyBody().strength(-100 * repelForce))
.force(
"link",
d3
.forceLink(graphData.links)
.id((d: any) => d.id)
.distance(linkDistance),
)
.force("center", d3.forceCenter().strength(centerForce))
const height = Math.max(graph.offsetHeight, 250)
const width = graph.offsetWidth
const svg = d3
2023-07-23 00:27:41 +00:00
.select<HTMLElement, NodeData>("#" + container)
2023-06-18 17:47:07 +00:00
.append("svg")
.attr("width", width)
.attr("height", height)
2023-07-23 00:27:41 +00:00
.attr("viewBox", [-width / 2 / scale, -height / 2 / scale, width / scale, height / scale])
2023-06-18 17:47:07 +00:00
// draw links between nodes
const link = svg
.append("g")
.selectAll("line")
.data(graphData.links)
.join("line")
.attr("class", "link")
.attr("stroke", "var(--lightgray)")
.attr("stroke-width", 1)
2023-06-18 17:47:07 +00:00
// svg groups
const graphNode = svg.append("g").selectAll("g").data(graphData.nodes).enter().append("g")
// calculate color
2023-06-18 17:47:07 +00:00
const color = (d: NodeData) => {
const isCurrent = d.id === slug
2023-07-01 07:03:01 +00:00
if (isCurrent) {
return "var(--secondary)"
} else if (visited.has(d.id)) {
return "var(--tertiary)"
} else {
return "var(--gray)"
}
2023-06-18 17:47:07 +00:00
}
const drag = (simulation: d3.Simulation<NodeData, LinkData>) => {
function dragstarted(event: any, d: NodeData) {
if (!event.active) simulation.alphaTarget(1).restart()
d.fx = d.x
d.fy = d.y
}
function dragged(event: any, d: NodeData) {
d.fx = event.x
d.fy = event.y
}
function dragended(event: any, d: NodeData) {
if (!event.active) simulation.alphaTarget(0)
d.fx = null
d.fy = null
}
2023-07-23 00:27:41 +00:00
const noop = () => {}
2023-06-18 17:47:07 +00:00
return d3
.drag<Element, NodeData>()
.on("start", enableDrag ? dragstarted : noop)
.on("drag", enableDrag ? dragged : noop)
.on("end", enableDrag ? dragended : noop)
}
function nodeRadius(d: NodeData) {
const numLinks = links.filter((l: any) => l.source.id === d.id || l.target.id === d.id).length
return 2 + Math.sqrt(numLinks)
}
// draw individual nodes
const node = graphNode
.append("circle")
.attr("class", "node")
.attr("id", (d) => d.id)
.attr("r", nodeRadius)
.attr("fill", color)
.style("cursor", "pointer")
.on("click", (_, d) => {
const targ = resolveRelative(fullSlug, d.id)
window.spaNavigate(new URL(targ, window.location.toString()))
2023-06-18 17:47:07 +00:00
})
2023-07-23 00:27:41 +00:00
.on("mouseover", function (_, d) {
2023-08-19 23:28:44 +00:00
const neighbours: SimpleSlug[] = data[fullSlug].links ?? []
2023-07-23 00:27:41 +00:00
const neighbourNodes = d3
.selectAll<HTMLElement, NodeData>(".node")
.filter((d) => neighbours.includes(d.id))
2023-06-18 17:47:07 +00:00
const currentId = d.id
const linkNodes = d3
.selectAll(".link")
.filter((d: any) => d.source.id === currentId || d.target.id === currentId)
// highlight neighbour nodes
neighbourNodes.transition().duration(200).attr("fill", color)
// highlight links
2023-07-23 00:27:41 +00:00
linkNodes.transition().duration(200).attr("stroke", "var(--gray)").attr("stroke-width", 1)
2023-06-18 17:47:07 +00:00
const bigFont = fontSize * 1.5
// show text for self
const parent = this.parentNode as HTMLElement
d3.select<HTMLElement, NodeData>(parent)
.raise()
.select("text")
.transition()
.duration(200)
2023-07-23 00:27:41 +00:00
.attr("opacityOld", d3.select(parent).select("text").style("opacity"))
.style("opacity", 1)
.style("font-size", bigFont + "em")
2023-06-18 17:47:07 +00:00
})
2023-07-23 00:27:41 +00:00
.on("mouseleave", function (_, d) {
2023-06-18 17:47:07 +00:00
const currentId = d.id
const linkNodes = d3
.selectAll(".link")
.filter((d: any) => d.source.id === currentId || d.target.id === currentId)
linkNodes.transition().duration(200).attr("stroke", "var(--lightgray)")
const parent = this.parentNode as HTMLElement
d3.select<HTMLElement, NodeData>(parent)
.select("text")
.transition()
.duration(200)
2023-07-23 00:27:41 +00:00
.style("opacity", d3.select(parent).select("text").attr("opacityOld"))
.style("font-size", fontSize + "em")
2023-06-18 17:47:07 +00:00
})
// @ts-ignore
.call(drag(simulation))
// draw labels
const labels = graphNode
.append("text")
.attr("dx", 0)
.attr("dy", (d) => -nodeRadius(d) + "px")
2023-06-18 17:47:07 +00:00
.attr("text-anchor", "middle")
2023-07-23 00:27:41 +00:00
.text(
(d) => data[d.id]?.title || (d.id.charAt(1).toUpperCase() + d.id.slice(2)).replace("-", " "),
)
.style("opacity", (opacityScale - 1) / 3.75)
2023-06-18 17:47:07 +00:00
.style("pointer-events", "none")
2023-07-23 00:27:41 +00:00
.style("font-size", fontSize + "em")
2023-06-18 17:47:07 +00:00
.raise()
// @ts-ignore
.call(drag(simulation))
// set panning
if (enableZoom) {
svg.call(
d3
.zoom<SVGSVGElement, NodeData>()
.extent([
[0, 0],
[width, height],
])
.scaleExtent([0.25, 4])
.on("zoom", ({ transform }) => {
link.attr("transform", transform)
node.attr("transform", transform)
2023-07-23 00:27:41 +00:00
const scale = transform.k * opacityScale
2023-06-18 17:47:07 +00:00
const scaledOpacity = Math.max((scale - 1) / 3.75, 0)
labels.attr("transform", transform).style("opacity", scaledOpacity)
}),
)
}
// progress the simulation
simulation.on("tick", () => {
link
.attr("x1", (d: any) => d.source.x)
.attr("y1", (d: any) => d.source.y)
.attr("x2", (d: any) => d.target.x)
.attr("y2", (d: any) => d.target.y)
2023-07-23 00:27:41 +00:00
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)
2023-06-18 17:47:07 +00:00
})
}
function renderGlobalGraph() {
const slug = getFullSlug(window)
2023-06-18 17:47:07 +00:00
const container = document.getElementById("global-graph-outer")
2023-07-05 00:14:15 +00:00
const sidebar = container?.closest(".sidebar") as HTMLElement
2023-06-18 17:47:07 +00:00
container?.classList.add("active")
2023-07-05 00:14:15 +00:00
if (sidebar) {
sidebar.style.zIndex = "1"
}
renderGraph("global-graph-container", slug)
2023-06-18 17:47:07 +00:00
2023-06-20 03:37:45 +00:00
function hideGlobalGraph() {
2023-06-18 17:47:07 +00:00
container?.classList.remove("active")
2023-06-20 03:37:45 +00:00
const graph = document.getElementById("global-graph-container")
2023-07-05 00:14:15 +00:00
if (sidebar) {
sidebar.style.zIndex = "unset"
}
2023-06-20 03:37:45 +00:00
if (!graph) return
2023-06-18 17:47:07 +00:00
removeAllChildren(graph)
}
2023-06-20 03:37:45 +00:00
registerEscapeHandler(container, hideGlobalGraph)
2023-06-18 17:47:07 +00:00
}
document.addEventListener("nav", async (e: unknown) => {
const slug = (e as CustomEventMap["nav"]).detail.url
2023-07-01 07:03:01 +00:00
addToVisited(slug)
2023-06-18 17:47:07 +00:00
await renderGraph("graph-container", slug)
const containerIcon = document.getElementById("global-graph-icon")
containerIcon?.removeEventListener("click", renderGlobalGraph)
containerIcon?.addEventListener("click", renderGlobalGraph)
})