feat(graph): obsidianLikeFocusOnHover (#1017)

Dinu Blanovschi

2024-05-29 0b9f79e1b779d727588cb9aa475a1cad1c8f237d

 quartz/components/scripts/graph.inline.ts

@@ -1,31 +1,32 @@
import { ContentDetails } from "../../plugins/emitters/contentIndex"
import * as d3 from 'd3'
import type { ContentDetails, ContentIndex } from "../../plugins/emitters/contentIndex"
import * as d3 from "d3"
import { registerEscapeHandler, removeAllChildren } from "./util"
import { CanonicalSlug, getCanonicalSlug, getClientSlug, resolveRelative } from "../../path"
import { FullSlug, SimpleSlug, getFullSlug, resolveRelative, simplifySlug } from "../../util/path"

type NodeData = {
  id: CanonicalSlug,
  text: string,
  id: SimpleSlug
  text: string
  tags: string[]
} & d3.SimulationNodeDatum

type LinkData = {
  source: CanonicalSlug,
  target: CanonicalSlug
  source: SimpleSlug
  target: SimpleSlug
}

const localStorageKey = "graph-visited"
function getVisited(): Set<CanonicalSlug> {
function getVisited(): Set<SimpleSlug> {
  return new Set(JSON.parse(localStorage.getItem(localStorageKey) ?? "[]"))
}

function addToVisited(slug: CanonicalSlug) {
function addToVisited(slug: SimpleSlug) {
  const visited = getVisited()
  visited.add(slug)
  localStorage.setItem(localStorageKey, JSON.stringify([...visited]))
}

async function renderGraph(container: string, slug: CanonicalSlug) {
async function renderGraph(container: string, fullSlug: FullSlug) {
  const slug = simplifySlug(fullSlug)
  const visited = getVisited()
  const graph = document.getElementById(container)
  if (!graph) return
@@ -40,23 +41,46 @@
    centerForce,
    linkDistance,
    fontSize,
    opacityScale
    opacityScale,
    removeTags,
    showTags,
    focusOnHover,
  } = JSON.parse(graph.dataset["cfg"]!)

  const data = await fetchData

  const data: Map<SimpleSlug, ContentDetails> = new Map(
    Object.entries<ContentDetails>(await fetchData).map(([k, v]) => [
      simplifySlug(k as FullSlug),
      v,
    ]),
  )
  const links: LinkData[] = []
  for (const [src, details] of Object.entries<ContentDetails>(data)) {
  const tags: SimpleSlug[] = []

  const validLinks = new Set(data.keys())
  for (const [source, details] of data.entries()) {
    const outgoing = details.links ?? []

    for (const dest of outgoing) {
      if (src in data && dest in data) {
        links.push({ source: src as CanonicalSlug, target: dest })
      if (validLinks.has(dest)) {
        links.push({ source: 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: source, target: tag })
      }
    }
  }

  const neighbourhood = new Set<CanonicalSlug>()
  const wl: (CanonicalSlug | "__SENTINEL")[] = [slug, "__SENTINEL"]
  const neighbourhood = new Set<SimpleSlug>()
  const wl: (SimpleSlug | "__SENTINEL")[] = [slug, "__SENTINEL"]
  if (depth >= 0) {
    while (depth >= 0 && wl.length > 0) {
      // compute neighbours
@@ -66,18 +90,26 @@
        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 as CanonicalSlug))
    validLinks.forEach((id) => neighbourhood.add(id))
    if (showTags) tags.forEach((tag) => neighbourhood.add(tag))
  }

  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))
  const graphData: { nodes: NodeData[]; links: LinkData[] } = {
    nodes: [...neighbourhood].map((url) => {
      const text = url.startsWith("tags/") ? "#" + url.substring(5) : data.get(url)?.title ?? url
      return {
        id: url,
        text: text,
        tags: data.get(url)?.tags ?? [],
      }
    }),
    links: links.filter((l) => neighbourhood.has(l.source) && neighbourhood.has(l.target)),
  }

  const simulation: d3.Simulation<NodeData, LinkData> = d3
@@ -96,11 +128,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 +152,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 +177,7 @@
      d.fy = null
    }

    const noop = () => { }
    const noop = () => {}
    return d3
      .drag<Element, NodeData>()
      .on("start", enableDrag ? dragstarted : noop)
@@ -158,6 +190,8 @@
    return 2 + Math.sqrt(numLinks)
  }

  let connectedNodes: SimpleSlug[] = []

  // draw individual nodes
  const node = graphNode
    .append("circle")
@@ -167,28 +201,44 @@
    .attr("fill", color)
    .style("cursor", "pointer")
    .on("click", (_, d) => {
      const targ = resolveRelative(slug, d.id)
      window.spaNavigate(new URL(targ, getClientSlug(window)))
      const targ = resolveRelative(fullSlug, d.id)
      window.spaNavigate(new URL(targ, window.location.toString()))
    })
    .on("mouseover", function(_, d) {
      const neighbours: CanonicalSlug[] = data[slug].links ?? []
      const neighbourNodes = d3.selectAll<HTMLElement, NodeData>(".node").filter((d) => neighbours.includes(d.id))
      console.log(neighbourNodes)
    .on("mouseover", function (_, d) {
      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)
      if (focusOnHover) {
        // fade out non-neighbour nodes
        connectedNodes = linkNodes.data().flatMap((d: any) => [d.source.id, d.target.id])

        d3.selectAll<HTMLElement, NodeData>(".link")
          .transition()
          .duration(200)
          .style("opacity", 0.2)
        d3.selectAll<HTMLElement, NodeData>(".node")
          .filter((d) => !connectedNodes.includes(d.id))
          .transition()
          .duration(200)
          .style("opacity", 0.2)

        d3.selectAll<HTMLElement, NodeData>(".node")
          .filter((d) => !connectedNodes.includes(d.id))
          .nodes()
          .map((it) => d3.select(it.parentNode as HTMLElement).select("text"))
          .forEach((it) => {
            let opacity = parseFloat(it.style("opacity"))
            it.transition()
              .duration(200)
              .attr("opacityOld", opacity)
              .style("opacity", Math.min(opacity, 0.2))
          })
      }

      // 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

@@ -199,11 +249,21 @@
        .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) {
      if (focusOnHover) {
        d3.selectAll<HTMLElement, NodeData>(".link").transition().duration(200).style("opacity", 1)
        d3.selectAll<HTMLElement, NodeData>(".node").transition().duration(200).style("opacity", 1)

        d3.selectAll<HTMLElement, NodeData>(".node")
          .filter((d) => !connectedNodes.includes(d.id))
          .nodes()
          .map((it) => d3.select(it.parentNode as HTMLElement).select("text"))
          .forEach((it) => it.transition().duration(200).style("opacity", it.attr("opacityOld")))
      }
      const currentId = d.id
      const linkNodes = d3
        .selectAll(".link")
@@ -216,8 +276,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))
@@ -228,10 +288,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))
@@ -249,7 +309,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)
        }),
@@ -263,17 +323,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 = getCanonicalSlug(window) 
  const slug = getFullSlug(window)
  const container = document.getElementById("global-graph-outer")
  const sidebar = container?.closest(".sidebar") as HTMLElement
  container?.classList.add("active")
@@ -296,13 +352,12 @@
  registerEscapeHandler(container, hideGlobalGraph)
}

document.addEventListener("nav", async (e: unknown) => {
  const slug = (e as CustomEventMap["nav"]).detail.url
document.addEventListener("nav", async (e: CustomEventMap["nav"]) => {
  const slug = e.detail.url
  addToVisited(slug)
  await renderGraph("graph-container", slug)

  const containerIcon = document.getElementById("global-graph-icon")
  containerIcon?.removeEventListener("click", renderGlobalGraph)
  containerIcon?.addEventListener("click", renderGlobalGraph)
  window.addCleanup(() => containerIcon?.removeEventListener("click", renderGlobalGraph))
})