Klasse: Pivotick <a class="header-anchor" href="#class-pivotick" aria-label="Permalink to “Klasse: Pivotick”">​

Würfe

Fehler, wenn bereits ein Knoten mit derselben id existiert. Löst onChange aus, nachdem der Knoten erfolgreich hinzugefügt wurde.

addNote()

addNote(n): Note | undefined

Definiert in: Graph.ts:1265

Fügt dem Diagramm eine Notiz hinzu und zeichnet es. Nimmt die gleichen Optionen wie data.notes (was Note.toJSON zurückgibt) oder Note an. Gibt noteAdd ab.

Parameter

n

Note | NoteOptions

Rückgabewert

Note | undefined

die Note oder undefined, während UI.notes.enabled false ist.

Würfe

Fehler, wenn bereits eine Notiz mit derselben id vorhanden ist.

addToSelection()

addToSelection(nodes): void

Definiert in: Graph.ts:1637

Fügt Knoten zur aktuellen Auswahl hinzu und lässt die bereits ausgewählten Knoten an Ort und Stelle. Bereits ausgewählte Knoten werden ignoriert.

Nur Knoten: Die Interaktionsschicht hat keinen additiven Setter für Kanten, die nur als ganze Menge über selectElements ausgewählt werden können.

Parameter

nodes

Die Nodes zum Hinzufügen.

Rückgabewert

void

clearEmphasis()

clearEmphasis(): void

Definiert in: Graph.ts:1726

Beenden Sie die Hervorhebung emphasiseElements gestartet: Die Arbeitsfläche liest sich wieder normal.

Rückgabewert

void

clearForecast()

clearForecast(): void

Definiert in: Graph.ts:1745

Nehmen Sie die Prognose herunter.

Rückgabewert

void

clearHighlightedElements()

clearHighlightedElements(): void

Definiert in: Graph.ts:1707

Entfernen Sie alle Highlight-Klassen von allen Knoten oder Kanten

Rückgabewert

void

closeTable()

closeTable(): void

Definiert in: Graph.ts:1669

Schließt das Datendock.

Rückgabewert

void

deselectAll()

deselectAll(): void

Definiert in: Graph.ts:1681

Alle abwählen

Rückgabewert

void

destroy()

destroy(): void

Definiert in: Graph.ts:1444

Zerstöre alle UI-Komponenten.

Rückgabewert

void

edgeVisibilityChanged()

edgeVisibilityChanged(): void

Definiert in: Graph.ts:1388

Nach einem Kantenschichtwechsel neu streichen. Bewusst nicht onChange: Schichten berühren die Verbindungskraft nicht (siehe Simulation.getActiveEdges), daher würde ein Neustart der Simulation den Graphen ohne Grund verschieben.

Rückgabewert

void

emphasiseElements()

emphasiseElements(elements): void

Definiert in: Graph.ts:1721

Wählen Sie einen Satz von Elementen aus dem Diagramm aus: Sie behalten das Aussehen, das sie bereits haben, während alles andere auf der Arbeitsfläche dunkler wird, bis clearEmphasis. Wenn Sie den Mauszeiger über einen Legendeneintrag bewegen, wird dessen Kategorie auf der Arbeitsfläche abgelesen.

Wo highlightElement auf ein Element zeigt, beschreibt dies eine Gruppe. Elemente, die gerade nicht gezeichnet werden, werden übersprungen und ein leerer Satz verdunkelt nichts.

Parameter

elements

(Node | Edge)[]

Die Nodes und Edges zum Hervorheben.

Rückgabewert

void

focusElement()

focusElement(element): void

Definiert in: Graph.ts:1583

Bringt den angegebenen Knoten oder die angegebene Kante in der Diagrammansicht in den Fokus. Ein in einem geschlossenen Cluster oder einer geschlossenen Gruppe verborgener Knoten rückt diesen Cluster oder diese Gruppe in den Fokus.

Parameter

element

Die Node oder Edge zum Fokussieren.

Node | Edge | Note

Rückgabewert

void

getAppID()

getAppID(): string

Definiert in: Graph.ts:1456

Die ID der App

Rückgabewert

string

getConnectedNodes()

getConnectedNodes(node): Node[]

Definiert in: Graph.ts:1241

Ruft alle Knoten ab, die direkt mit dem angegebenen Knoten verbunden sind.

Gibt geklonte Knoten zurück, um externe Änderungen zu verhindern.

Parameter

node

Der Knoten oder die Knoten-ID, von der aus Verbindungen gesucht werden sollen.

string | Node

Rückgabewert

Ein Array von Node Objekten, die direkt vom angegebenen Knoten aus verbunden sind.

getEdge()

getEdge(id): Edge | undefined

Definiert in: Graph.ts:1036

Ruft eine Kante anhand ihrer ID aus dem Diagramm ab.

Gibt einen tiefen Klon der Kante zurück, um externe Mutationen zu verhindern.

Parameter

id

string

Die ID der Kante.

Rückgabewert

Edge | undefined

Ein geklontes Edge, falls gefunden, andernfalls undefined.

getEdgeCount()

getEdgeCount(): number

Definiert in: Graph.ts:1086

Gibt die Anzahl der Kanten zurück, die derzeit im Diagramm vorhanden sind.

Rückgabewert

number

Die Gesamtkantenanzahl.

getEdges()

getEdges(): Edge[]

Definiert in: Graph.ts:1168

Ruft alle Kanten im Diagramm ab.

Gibt Klone der Kanten zurück, um externe Änderungen zu verhindern.

Rückgabewert

Ein Array geklonter Edge Objekte.

getEdgesFromNode()

getEdgesFromNode(node): Edge[]

Definiert in: Graph.ts:1211

Findet alle Kanten, die von einem bestimmten Knoten ausgehen.

Gibt geklonte Kanten zurück, um externe Änderungen zu verhindern.

Parameter

node

Der Knoten oder die Knoten-ID, von dem ausgehende Kanten gesucht werden sollen.

string | Node

Rückgabewert

Ein Array von Edge Objekten, deren from Knoten mit der Abfrage übereinstimmt.

getEdgesToNode()

getEdgesToNode(node): Edge[]

Definiert in: Graph.ts:1226

Findet alle Kanten, die auf einen bestimmten Knoten zeigen.

Gibt geklonte Kanten zurück, um externe Änderungen zu verhindern.

Parameter

node

Der Knoten oder die Knoten-ID, zu dem eingehende Kanten gefunden werden sollen.

string | Node

Rückgabewert

Ein Array von Edge Objekten, deren to Knoten mit der Abfrage übereinstimmt.

getGraphDepth()

getGraphDepth(): number

Definiert in: Graph.ts:1566

Rückgabewert

number

getMutableEdge()

getMutableEdge(id): Edge | undefined

Definiert in: Graph.ts:1052

Ruft eine Kante anhand ihrer ID aus dem Diagramm ab.

Gibt die tatsächliche Kanteninstanz zurück und ermöglicht direkte Änderungen.

Warnung: Das direkte Ändern von Kanten mit dieser Methode kann zu unerwartetem Verhalten führen. Im Allgemeinen ist es sicherer, getEdge zu verwenden, das eine geklonte Instanz zurückgibt.

Parameter

id

string

Die ID der Kante.

Rückgabewert

Edge | undefined

Die Edge, falls gefunden, andernfalls undefined.

getMutableEdges()

getMutableEdges(): Edge[]

Definiert in: Graph.ts:1184

Ruft alle Kanten im Diagramm ab.

Gibt die tatsächlichen Kanteninstanzen zurück und ermöglicht direkte Änderungen.

Rückgabewert

Ein Array von Edge Objekten.

Bemerkungen

⚠️ Warnung: Das direkte Ändern von Kanten kann zu unerwartetem Verhalten führen. Verwenden Sie stattdessen getEdges, um mit sicheren Klonen zu arbeiten.

getMutableNode()

getMutableNode(id): Node | undefined

Definiert in: Graph.ts:943

Ruft einen Knoten anhand seiner ID aus dem Diagramm ab.

Gibt die tatsächliche Knoteninstanz zurück und ermöglicht direkte Änderungen.

Warnung: Das direkte Ändern von Knoten mit dieser Methode kann zu unerwartetem Verhalten führen. Im Allgemeinen ist es sicherer, getNode zu verwenden, das eine geklonte Instanz zurückgibt.

Parameter

id

Die ID des Knotens oder eines Node-Objekts.

string | Node

Rückgabewert

Node | undefined

Die Node, falls gefunden, andernfalls undefined.

getMutableNodes()

getMutableNodes(): Node[]

Definiert in: Graph.ts:1114

Ruft alle Knoten im Diagramm ab.

Gibt die tatsächlichen Knoteninstanzen zurück und ermöglicht direkte Änderungen.

Rückgabewert

Ein Array von Node Objekten.

Bemerkungen

⚠️ Warnung: Das direkte Ändern von Knoten kann zu unerwartetem Verhalten führen. Im Allgemeinen ist es sicherer, getNodes zu verwenden, das geklonte Instanzen zurückgibt.

getMutableVisibleEdges()

getMutableVisibleEdges(): Edge[]

Definiert in: Graph.ts:1199

Ruft alle sichtbaren Kanten im Diagramm ab.

Gibt die tatsächlichen Kanteninstanzen zurück und ermöglicht direkte Änderungen.

Rückgabewert

Ein Array von Edge Objekten.

Bemerkungen

⚠️ Warnung: Das direkte Ändern von Kanten kann zu unerwartetem Verhalten führen. Verwenden Sie stattdessen getEdges, um mit sicheren Klonen zu arbeiten.

getMutableVisibleNodes()

getMutableVisibleNodes(): Node[]

Definiert in: Graph.ts:1130

Ruft alle sichtbaren Knoten im Diagramm ab. Rekursives Hinzufügen sichtbarer Kinder

Gibt die tatsächlichen Knoteninstanzen zurück und ermöglicht direkte Änderungen.

Rückgabewert

Ein Array von Node Objekten.

Bemerkungen

⚠️ Warnung: Das direkte Ändern von Knoten kann zu unerwartetem Verhalten führen. Im Allgemeinen ist es sicherer, getNodes zu verwenden, das geklonte Instanzen zurückgibt.

getNode()

getNode(id): Node | undefined

Definiert in: Graph.ts:927

Ruft einen Knoten anhand seiner ID aus dem Diagramm ab.

Gibt einen tiefen Klon des Knotens zurück, um externe Mutationen zu verhindern.

Parameter

id

Die ID des Knotens oder eines Node-Objekts.

string | Node

Rückgabewert

Node | undefined

Ein geklontes Node, falls gefunden, andernfalls undefined.

getNodeCount()

getNodeCount(): number

Definiert in: Graph.ts:1077

Gibt die Anzahl der Knoten zurück, die derzeit im Diagramm vorhanden sind.

Rückgabewert

number

Die Gesamtknotenanzahl.

getNodes()

getNodes(): Node[]

Definiert in: Graph.ts:1097

Ruft alle Knoten im Diagramm ab.

Gibt Klone der Knoten zurück, um externe Änderungen zu verhindern.

Rückgabewert

Ein Array geklonter Node Objekte.

getNote()

getNote(id): Note | undefined

Definiert in: Graph.ts:1254

Parameter

id

string

Rückgabewert

Note | undefined

getNotes()

getNotes(): Note[]

Definiert in: Graph.ts:1250

Rückgabewert

Note[]

getOptions()

getOptions(): GraphOptions

Definiert in: Graph.ts:693

Gibt die aktuellen Konfigurationsoptionen des Diagramms zurück.

Rückgabewert

GraphOptions

hideNode()

hideNode(node): void

Definiert in: Graph.ts:1393

Parameter

node

Rückgabewert

void

highlightElement()

highlightElement(element): void

Definiert in: Graph.ts:1690

Fügen Sie dem angegebenen Knoten oder der angegebenen Kante eine Hervorhebungsklasse hinzu

Parameter

element

Die Node oder Edge zum Hervorheben.

Node | Edge

Rückgabewert

void

nextTick()

nextTick(): void

Definiert in: Graph.ts:1430

Lösen Sie die nächste Renderaktualisierung des Diagramms aus.

Rückgabewert

void

nextTickFor()

nextTickFor(nodes): void

Definiert in: Graph.ts:1437

Lösen Sie die nächste Renderaktualisierung des Diagramms für die übergebenen Themen aus.

Parameter

nodes

Rückgabewert

void

noteAdd()

noteAdd(note): void

Definiert in: Graph.ts:422

Parameter

note

Note

Rückgabewert

void

noteChange()

noteChange(note): void

Definiert in: Graph.ts:425

Parameter

note

Note

Rückgabewert

void

noteRemove()

noteRemove(note): void

Definiert in: Graph.ts:428

Parameter

note

Note

Rückgabewert

void

off()

off<K>(event, handler): void

Definiert in: Graph.ts:258

Typparameter

K

K erweitert Schlüssel von GraphEvents

Parameter

event

K

handler

GraphEvents[K]

Rückgabewert

void

on()

on<K>(event, handler): void

Definiert in: Graph.ts:251

Typparameter

K

K erweitert Schlüssel von GraphEvents

Parameter

event

K

handler

GraphEvents[K]

Rückgabewert

void

openTable()

openTable(): void

Definiert in: Graph.ts:1662

Öffnet das Datendock – die Zeilen des Diagramms als sortierbares, auswählbares Raster, das am unteren Rand der Arbeitsfläche abgetrennt ist. Nur im full-Modus und nur, wenn UI.table dies zulässt; Ansonsten ein No-Op.

Das Dock kann jetzt andere Bereiche als die Tabelle enthalten, daher wird dadurch auch der Bereich der Tabelle in den Vordergrund gebracht: Der Aufruf ist nach der Tabelle benannt und sollte Ihnen einen anzeigen. Greifen Sie nach UIManager.dock oder activateDockTab(), um die Region ohne diese Angabe zu befahren.

Rückgabewert

void

removeBySource()

removeBySource(source): object

Definiert in: Graph.ts:592

Entfernen Sie alles, wofür eine Quelle bürgt. Ein Element, für das mehrere Quellen bürgen, ist erhalten geblieben, eine Behauptung ist leichter: Es folgt die gleiche einheitliche Regel zum Rückgängigmachen von Pivots, und die einzige Möglichkeit, alles, was ein Pivot mit sich gebracht hat, zu entfernen.

Es handelt sich um eine Vorwärtsoperation und einen Eintrag in der Geschichte: Wenn man sie rückgängig macht, wird zurückgesetzt, was übrig geblieben ist, und der Anspruch der Quelle wird auf das zurückgeführt, was übriggeblieben ist.

Parameter

source

string

Eine Pivot-ID oder 'seed' für Daten, die nie geschwenkt wurden.

Rückgabewert

object

Was wurde tatsächlich entfernt.

edges

edges: Edge[]

nodes

nodes: Node[]

removeEdge()

removeEdge(id): void

Definiert in: Graph.ts:1062

Entfernt eine Kante anhand ihrer ID aus dem Diagramm.

Parameter

id

string

Die ID der zu entfernenden Kante. Löst onChange aus, nachdem die Kante entfernt wurde.

Rückgabewert

void

removeFromSelection()

removeFromSelection(nodes): void

Definiert in: Graph.ts:1648

Entfernt Knoten aus der aktuellen Auswahl und lässt den Rest an Ort und Stelle. Nur Knoten, zu den gleichen Bedingungen wie addToSelection.

Parameter

nodes

Die zu entfernenden Nodes.

Rückgabewert

void

removeNode()

removeNode(id): void

Definiert in: Graph.ts:969

Entfernt einen Knoten anhand seiner ID aus dem Diagramm.

Entfernt außerdem alle mit dem Knoten verbundenen Kanten.

Parameter

id

string

Die ID des zu entfernenden Knotens. Löst onChange aus, nachdem der Knoten und seine Kanten entfernt wurden.

Rückgabewert

void

selectElement()

selectElement(element): void

Definiert in: Graph.ts:1593

Wählt einen bestimmten Knoten oder eine bestimmte Kante im Diagramm aus. Ein in einem geschlossenen Cluster oder einer geschlossenen Gruppe verborgener Knoten ist immer noch der ausgewählte; Die Arbeitsfläche beleuchtet den dafür gezeichneten Cluster oder die Gruppe.

Parameter

element

Die Node oder Edge zur Auswahl.

Node | Edge

Rückgabewert

void

selectElements()

selectElements(elements): void

Definiert in: Graph.ts:1610

Wählt mehrere Knoten oder mehrere Kanten aus und ersetzt die aktuelle Auswahl – den Plural selectElement – und löst das gerenderte Handle jedes Elements für Sie auf.

Knoten und Kanten können nicht zusammen ausgewählt werden (die Interaktionsschicht löscht eine Art, wenn die andere festgelegt ist), daher wählt ein gemischtes Array die Knoten aus und warnt.

Parameter

elements

(Node | Edge)[]

Die Nodeen oder Edgeen zur Auswahl. Ein leeres Array löscht die Auswahl.

Rückgabewert

void

setData()

setData(nodes, edges, notes): void

Definiert in: Graph.ts:852

Ersetzt alle aktuellen Knoten und Kanten im Diagramm durch die bereitgestellten Daten. Löscht vorhandene Knoten und Kanten, bevor die neuen festgelegt werden. Löst den onChange-Callback nach dem Update aus.

Parameter

nodes

Node[] = []

Array der festzulegenden Knoten. Standardmäßig ist ein leeres Array.

edges

Edge[] = []

Array von festzulegenden Kanten. Standardmäßig ist ein leeres Array.

notes

Note[] = []

Rückgabewert

void

setLegend()

setLegend(config?): void

Definiert in: Graph.ts:450

Ersetzen Sie die Canvas-Legende zur Laufzeit – den zwingenden Zwilling von UI.legend. Ein Diagramm, das ohne eines begann, wird sofort erstellt; false leert die Legende und löscht ihren Filter, und true / undefined greift auf die Ableitung einer von render.nodeTypeAccessor zurück. Übergeben Sie eine LegendGroupOptions, um das Diagramm in mehreren Dimensionen gleichzeitig zu erfassen.

Parameter

config?

Die Legende, die angezeigt werden soll, oder false, um sie zu entfernen.

boolean | LegendOptions | LegendGroupOptions

Rückgabewert

void

setNotes()

setNotes(notes): Note[]

Definiert in: Graph.ts:1282

Ersetzt die Notizen des Diagramms und lässt Knoten und Kanten in Ruhe. Notizen werden nach ID abgeglichen: Eine Notiz, die sich bereits auf der Arbeitsfläche befindet, wird an ihrer Stelle aktualisiert, sodass ihre Zeichnung daran gebunden bleibt, eine Notiz, die nicht in notes ist, wird entfernt und eine neue wird hinzugefügt.

Parameter

notes

(Note | NoteOptions)[]

Rückgabewert

Note[]

Die Notizen jetzt in der angegebenen Reihenfolge in der Grafik.

Würfe

Fehler, wenn zwei Einträge eine ID teilen. Dann ändert sich nichts.

setVisibleNodes()

setVisibleNodes(nodes, notify): boolean

Definiert in: Graph.ts:1356

Gibt zurück, ob etwas verschoben wurde, sodass sich eine Filteränderung, die nur auf die Kante beschränkt, selbst neu zeichnen kann. notify ist für den ersten Durchgang der Abfrage-Engine deaktiviert, der ausgeführt wird, bevor etwas gezeichnet wird – die eigenen simulation.update() / renderer.init() des Konstruktors folgen ihm.

Parameter

nodes

notify

boolean = true

Rückgabewert

boolean

showForecast()

showForecast(forecast): void

Definiert in: Graph.ts:1740

Malen Sie, was eine Aktion ** tun würde, und ändern Sie nichts anderes: Die Elemente, die sie wegnehmen würde, verschwinden an Ort und Stelle, diejenigen, die sie mit ihnen verstecken würde, und was auch immer sie zurückbringen würde, wird umrissen, wo es landen würde.

Während emphasiseElements einen Satz aus der Arbeitsfläche liest, indem er den Rest zurückzieht, antwortet eine Prognose mit „Was passiert, wenn ich klicke“ – das Diagramm muss also weiterhin normal um die wenigen Elemente herum lesen, die sich ändern würden. graph.history.preview(...) gibt eins fertig zurück.

Parameter

forecast

GraphForecast

Rückgabewert

void

showNode()

showNode(node): void

Definiert in: Graph.ts:1404

Parameter

node

Rückgabewert

void

toggleExpandNode()

toggleExpandNode(node): void

Definiert in: Graph.ts:1415

Parameter

node

Rückgabewert

void

toggleExpandNodes()

toggleExpandNodes(nodes): void

Definiert in: Graph.ts:1420

Parameter

nodes

Rückgabewert

void

toggleTable()

toggleTable(): void

Definiert in: Graph.ts:1674

Öffnet das Datendock, wenn es geschlossen ist, und schließt es, wenn es geöffnet ist.

Rückgabewert

void

unHighlightElement()

unHighlightElement(element): void

Definiert in: Graph.ts:1699

Entfernen Sie eine Hervorhebungsklasse für den angegebenen Knoten oder die angegebene Kante

Parameter

element

Die Node oder Edge zur Auswahl.

Node | Edge

Rückgabewert

void

updateData()

updateData(newNodes?, newEdges?, triggerChangeEvent?): void

Definiert in: Graph.ts:764

Aktualisiert das Diagramm mit neuen Knoten und/oder Kanten.

Eine ID, die das Diagramm bereits enthält, wird an Ort und Stelle aktualisiert: Was das Element ist – seine Daten, sein Stil und sein Gewicht – wird zu dem, was Sie übergeben haben, während das Objekt selbst seine Identität behält. So muss es funktionieren. Seine Kanten, die Simulation und die DOM-Bindung enthalten alle dieses Objekt, ebenso wie alles, was es seit seiner Erstellung gelernt hat: welche Quellen es belegen, wo es sich befindet, ob es angeheftet ist. Eine Position auf dem eingehenden Element gewinnt immer noch, sodass updateData sowohl etwas verschieben als auch aktualisieren kann. Unbekannte IDs wurden hinzugefügt.

Die children eines Containers werden hier nicht umstrukturiert – führen Sie den Container durch removeNode und addNode, um zu ändern, was er enthält.

Der gesamte Aufruf ist ein Batch: ein dataBatchChanged, der alle Hinzufügungen und Änderungen in der angegebenen Reihenfolge auflistet, dann ein erneutes Rendern, egal wie viele Elemente es enthält.

Parameter

newNodes?

Optionales Array von Knoten zum Aktualisieren oder Hinzufügen.

newEdges?