common-data-structures.md

Common Data Structures

Bennenung der Datentypen nicht notwendiger Weise final.

Frage: Gibt es einen eleganten Weg, die Datenstruktur Graph und den Force-Graph Renderer namentlich zu unterscheiden? Momentan gibt es GraphData und NodeData, was auf die reine Datenstruktur hinweist, und dann aber GraphNode was auf den Renderer deuten soll, aber eher verwirrt. Vorschläge:

• Renderer
  • RendererNode
• Canvas
  • CanvasNode
• UI
  • UINode
• Force (Allerdings auch irgendwie irreführend, oder? Ergibt aber Sinn im Hinblick auf die Simulationsattribute vx, vy, ...)
  • ForceNode

Reine Daten

Alle URLs sollen absolut als string angegeben werden.

GraphData

• Nodes: NodeData[]
• Links: LinkData[]
• Types: NodeTypes[]

NodeData

• Id: number
• Label: string
• Description: string
• Type: NodeType
• Icon: string
  • URL für Bild für Knoten im Graphen
• Banner: string
  • URL für Bild in der Detailansicht
• Video: string
  • URL für Video in Detailansicht
• References: string[]
  • Liste an weiterführenden URLs
  • Werden im Backend dann nicht ordentlich gespeichert, sondern in einer Zelle, Komma-separiert o.ä.
• Folgende Attribue führen über die reine Datenstruktur hinaus, können aber beim laden entsprechend ergänzt werden
  • Links: LinkData[]
  • Neighbours: NodeData[]
  • Es sei angemerkt, dass die idealerweise dynamisch über eine Verbindung zum Graphen und einem Getter erstellt werden sollten, damit man die nicht manuell aktuell halten muss. Inbesondere interessant für den Editor.

So könnte eine dynamische Implementierung der verbundenen Links für eine Node aussehen, wobei graph dem zugehörigen Graphen entspricht:

public get links(): Link[] {
    const links: Link[] = [];

    // Collect all links that are connected to the current node
    this.graph.links.forEach((link) => {
        // Contains() returns true, if node is part of link
        if (link.contains(this)) {
            links.push(link);
        }
    });

    return links;
}

LinkData

• Source: NodeData
• Target: NodeData
• Zur Einfacheit vielleicht noch folgende, da nicht immer das gesamte Node Objekt geladen sein wird
  • SourceId: number
  • TargetId: number

NodeType

• Name: string
• Color: string
  • Als Hexcode? Datentyp hier noch offen

Force-Graph Erweiterungen

@Matthias, da hattest du doch bereits einiges rausgesucht. Die bisherigen angaben zu GraphNode sind Attribute die ich benötige.

GraphNode : NodeData

• index
• x
• y
• vx
• vy
• fx
• fy
• ...

GraphLink : LinkData

• material?

Erweiterung um grundlegende Funktionen

JSONGraph

Ich weiß nicht, ob JSON ein guter Name dafür ist, doch mir schien parse und serialize teilweise etwas undefiniert.

• toJSON(): any
• fromJSON( any ): GraphData

DisplayGraph

• view( nodeFilter, linkFilter ): GraphData

EditorGraph

• addNode( NodeData ): boolean
• deleteNode( NodeData ): boolean
• addLink( LinkData ): boolean
• deleteLink( LinkData ): boolean
• Sollte von ManagedData erben, welches im Brachn typescript-graph-object-from-editor bereits in seiner TypeScript Form in knowledge-space-wp-plugin/src/editor/js/structures/manageddata.ts gefunden werden kann. Es enthält neben einigen Attributen auch folgende Funktionen:
  • undo(): boolean
  • redo(): boolean
  • storeCurrentData( description: string )