trilium/src/public/javascripts/services/link_map.js

import libraryLoader from "./library_loader.js";
import server from "./server.js";
import treeCache from "./tree_cache.js";
import linkService from "./link.js";

const linkOverlays = [
    [ "Arrow", {
        location: 1,
        id: "arrow",
        length: 10,
        width: 10,
        foldback: 0.7
    } ]
];

export default class LinkMap {
    constructor(note, $linkMapContainer, options = {}) {
        this.note = note;
        this.options = Object.assign({
            maxDepth: 10,
            maxNotes: 30,
            zoom: 1.0,
            stopCheckerCallback: () => false
        }, options);

        this.$linkMapContainer = $linkMapContainer;
        this.linkMapContainerId = this.$linkMapContainer.attr("id");
    }

    async render() {
        await libraryLoader.requireLibrary(libraryLoader.LINK_MAP);

        jsPlumb.ready(() => {
            if (this.options.stopCheckerCallback()) {
                return;
            }

            this.initJsPlumbInstance();

            this.initPanZoom();

            this.loadNotesAndRelations();
        });
    }

    async loadNotesAndRelations(options = {}) {
        this.options = Object.assign(this.options, options);

        this.cleanup();

        if (this.options.stopCheckerCallback()) {
            return;
        }

        const links = await server.post(`notes/${this.note.noteId}/link-map`, {
            maxNotes: this.options.maxNotes,
            maxDepth: this.options.maxDepth
        });

        const noteIds = new Set(links.map(l => l.noteId).concat(links.map(l => l.targetNoteId)));

        if (noteIds.size === 0) {
            noteIds.add(this.note.noteId);
        }

        // preload all notes
        const notes = await treeCache.getNotes(Array.from(noteIds), true);

        const graph = new Springy.Graph();
        graph.addNodes(...noteIds);
        graph.addEdges(...links.map(l => [l.noteId, l.targetNoteId]));

        const layout = new Springy.Layout.ForceDirected(
            graph,
            this.options.stopCheckerCallback,
            // param explanation here: https://github.com/dhotson/springy/issues/58
            400.0, // Spring stiffness
            600.0, // Node repulsion
            0.15, // Damping
            0.1 // min energy threshold
        );

        const getNoteBox = noteId => {
            const noteBoxId = this.noteIdToId(noteId);
            const $existingNoteBox = $("#" + noteBoxId);

            if ($existingNoteBox.length > 0) {
                return $existingNoteBox;
            }

            const note = notes.find(n => n.noteId === noteId);

            if (!note) {
                return null;
            }

            const $noteBox = $("<div>")
                .addClass("note-box")
                .prop("id", noteBoxId);

            linkService.createNoteLink(noteId, {title: note.title}).then($link => {
                $link.on('click', e => {
                    try {
                        $link.tooltip('dispose');
                    }
                    catch (e) {}

                    linkService.goToLink(e);
                });

                $noteBox.append($("<span>").addClass("title").append($link));
            });

            if (noteId === this.note.noteId) {
                $noteBox.addClass("link-map-active-note");
            }

            $noteBox
                .mouseover(() => this.$linkMapContainer.find(".link-" + noteId).addClass("jsplumb-connection-hover"))
                .mouseout(() => this.$linkMapContainer.find(".link-" + noteId).removeClass("jsplumb-connection-hover"));

            this.$linkMapContainer.append($noteBox);

            this.jsPlumbInstance.draggable($noteBox[0], {
                start: params => {
                    this.renderer.stop();
                },
                drag: params => {},
                stop: params => {}
            });

            return $noteBox;
        };

        if (this.options.stopCheckerCallback()) {
            return;
        }

        this.renderer = new Springy.Renderer(layout);
        await this.renderer.start(500);

        layout.eachNode((node, point) => {
            const $noteBox = getNoteBox(node.id);
            const middleW = this.$linkMapContainer.width() / 2;
            const middleH = this.$linkMapContainer.height() / 2;

            $noteBox
                .css("left", (middleW + point.p.x * 100) + "px")
                .css("top", (middleH + point.p.y * 100) + "px");

            if ($noteBox.hasClass("link-map-active-note")) {
                this.moveToCenterOfElement($noteBox[0]);
            }
        });

        layout.eachEdge(edge => {
            const connectionId = this.linkMapContainerId + '-' + edge.source.id + '-' + edge.target.id;

            if ($("#" + connectionId).length > 0) {
                return;
            }

            getNoteBox(edge.source.id);
            getNoteBox(edge.target.id);

            const connection = this.jsPlumbInstance.connect({
                source: this.noteIdToId(edge.source.id),
                target: this.noteIdToId(edge.target.id),
                type: 'link'
            });

            if (connection) {
                $(connection.canvas)
                    .prop("id", connectionId)
                    .addClass('link-' + edge.source.id)
                    .addClass('link-' + edge.target.id);
            }
            else {
                console.debug(`connection not created for`, edge);
            }
        });

        this.jsPlumbInstance.repaintEverything();
    }

    moveToCenterOfElement(element) {
        const elemBounds = element.getBoundingClientRect();
        const containerBounds = this.pzInstance.getOwner().getBoundingClientRect();

        const centerX = -elemBounds.left + containerBounds.left + (containerBounds.width / 2) - (elemBounds.width / 2);
        const centerY = -elemBounds.top + containerBounds.top + (containerBounds.height / 2) - (elemBounds.height / 2);

        const transform = this.pzInstance.getTransform();

        const newX = transform.x + centerX;
        const newY = transform.y + centerY;

        this.pzInstance.moveTo(newX, newY);
    }

    initPanZoom() {
        if (this.pzInstance) {
            return;
        }

        this.pzInstance = panzoom(this.$linkMapContainer[0], {
            maxZoom: 2,
            minZoom: 0.3,
            smoothScroll: false,
            filterKey: function (e, dx, dy, dz) {
                // if ALT is pressed then panzoom should bubble the event up
                // this is to preserve ALT-LEFT, ALT-RIGHT navigation working
                return e.altKey;
            }
        });
    }

    cleanup() {
        if (this.renderer) {
            this.renderer.stop();
        }

        if (this.jsPlumbInstance) {
            // delete all endpoints and connections
            // this is done at this point (after async operations) to reduce flicker to the minimum
            this.jsPlumbInstance.deleteEveryEndpoint();

            // without this we still end up with note boxes remaining in the canvas
            this.$linkMapContainer.empty();

            // reset zoom/pan
            this.pzInstance.zoomAbs(0, 0, this.options.zoom);
            this.pzInstance.moveTo(0, 0);
        }
    }

    initJsPlumbInstance() {
        if (this.jsPlumbInstance) {
            this.cleanup();

            return;
        }

        this.jsPlumbInstance = jsPlumb.getInstance({
            Endpoint: ["Blank", {}],
            ConnectionOverlays: linkOverlays,
            PaintStyle: { stroke: "var(--muted-text-color)", strokeWidth: 1 },
            HoverPaintStyle: { stroke: "var(--main-text-color)", strokeWidth: 1 },
            Container: this.$linkMapContainer.attr("id")
        });

        this.jsPlumbInstance.registerConnectionType("link", { anchor: "Continuous", connector: "Straight", overlays: linkOverlays });
    }

    noteIdToId(noteId) {
        return this.linkMapContainerId + "-note-" + noteId;
    }
}