pivotick v3.0.0

---

Pivotick / Knoten

Klasse: Node

Definiert in: Node.ts:42

Stellt einen einzelnen Knoten (Scheitelpunkt) in einem Diagramm dar.

Zugriffsmethoden

isGroup

Getter-Signatur

get isGroup(): boolean

Definiert in: Node.ts:441

Gilt für eine Gruppe, die von graph.simplify gezogen wird: ein Stellvertreter für ihre Mitglieder, niemals Teil der Daten.

Rückgabewert

boolean

Konstruktoren

Konstruktor

new Node(id, data?, style?, domID?, children?): Node

Definiert in: Node.ts:108

Erstellen Sie eine neue Knoteninstanz.

Parameter

id

string

Eindeutiger Bezeichner für den Knoten

data?

NodeData

Optionale Datennutzlast, die dem Knoten zugeordnet ist

style?

Partial<NodeStyle>

domID?

string = ...

children?

Node[] = []

Rückgabewert

Node

Methoden

ancestorChain()

ancestorChain(): Node[]

Definiert in: Node.ts:400

Die Cluster des Knotens, die äußersten zuerst – leer für einen Knoten des Wurzeldiagramms.

Rückgabewert

Node[]

---

canvasRepresentative()

canvasRepresentative(): Node

Definiert in: Node.ts:419

Der Knoten, den die Arbeitsfläche tatsächlich für diesen Knoten zeichnet: sich selbst, wenn jeder Cluster darüber erweitert wird, andernfalls der äußerste reduzierte Cluster – das Kästchen, das ihn verbirgt – und in jedem Fall die geschlossene Gruppe, in die dieser Punkt gefaltet wird, falls vorhanden.

Dies antwortet mit „Welcher Punkt auf dem Bildschirm steht für diesen Knoten“ und nicht mit „Ist er sichtbar?“: Ein erweiterter Cluster stellt einen separaten Untergraphen dar, der aus toDict() Daten erstellt wurde, sodass ein verschachtelter Knoten niemals von diesem Graphen gezeichnet wird, selbst wenn sein Cluster geöffnet ist.

Rückgabewert

Node

---

clone()

clone(): Node

Definiert in: Node.ts:284

Rückgabewert

Node

---

collapse()

collapse(): void

Definiert in: Node.ts:388

Rückgabewert

void

---

degree()

degree(): number

Definiert in: Node.ts:395

Rückgabewert

number

---

descendants()

descendants(): Node[]

Definiert in: Node.ts:709

Jeder Knoten unterhalb dieses Knotens, Tiefe zuerst.

Rückgabewert

Node[]

---

expand()

expand(): void

Definiert in: Node.ts:381

Rückgabewert

void

---

freeze()

freeze(): void

Definiert in: Node.ts:335

Rückgabewert

void

---

getBorderBox()

getBorderBox(outset): NodeBorderBox | undefined

Definiert in: Node.ts:513

Der rechteckige Rand des Knotens vergrößert sich um outset oder undefined, wenn der Knoten als Kreis verankert ist.

Parameter

outset

number = 0

Rückgabewert

NodeBorderBox | undefined

---

getBorderDistance()

getBorderDistance(dirX, dirY, outset): number

Definiert in: Node.ts:525

Abstand vom Mittelpunkt des Knotens zu seinem Rand entlang der Einheitsrichtung (dirX, dirY), erhöht um outset – wo eine in diese Richtung verlaufende Kante beginnen sollte. Rechteckig für einen gemessenen Knoten, andernfalls der Kreisradius. Bewusst frei von Stilauflösung: Dies gilt für beide Enden jeder Kante bei jedem Tick.

Parameter

dirX

number

dirY

number

outset

number = 0

Rückgabewert

number

---

getCircleRadius()

getCircleRadius(): number

Definiert in: Node.ts:465

Rückgabewert

number

---

getCircleRadiusCollapsed()

getCircleRadiusCollapsed(): number

Definiert in: Node.ts:473

Rückgabewert

number

---

getConnectedNodes()

getConnectedNodes(): Node[]

Definiert in: Node.ts:184

Rückgabewert

Node[]

---

getConnectingNodes()

getConnectingNodes(): Node[]

Definiert in: Node.ts:190

Rückgabewert

Node[]

---

getData()

getData(): NodeData

Definiert in: Node.ts:129

Rufen Sie die Daten des Knotens ab.

Rückgabewert

NodeData

---

getEdgesIn()

getEdgesIn(): Edge[]

Definiert in: Node.ts:200

Rückgabewert

Edge[]

---

getEdgesOut()

getEdgesOut(): Edge[]

Definiert in: Node.ts:196

Rückgabewert

Edge[]

---

getGraphElement()

getGraphElement(): SVGGElement | null

Definiert in: Node.ts:230

Rückgabewert

SVGGElement | null

---

getLayoutRadius()

getLayoutRadius(): number

Definiert in: Node.ts:496

Der Radius, um den das Layout diesen Knoten verteilt: seinen deklarierten Footprint, wo er einen hat, und ansonsten unabhängig von der in der Zeichnung gemessenen Größe. Jede Macht liest dies; Auf den Schubladen steht getCircleRadius, was der gezeichneten Größe entspricht.

Rückgabewert

number

---

getLayoutSize()

getLayoutSize(): number | undefined

Definiert in: Node.ts:487

Die angegebene halbe Breite des Footprints oder undefined, wenn die Zeichnung den Abstand besitzt.

Rückgabewert

number | undefined

---

getPotential()

getPotential(pivotId): number | undefined

Definiert in: Node.ts:647

Das für einen Pivot deklarierte Potenzial oder – ohne Argument – die für keinen bestimmten Pivot deklarierte Summe. undefined wenn keiner da war.

Parameter

pivotId

string = SUMMARY_POTENTIAL

Rückgabewert

number | undefined

---

getPotentials()

getPotentials(): Map<string, number>

Definiert in: Node.ts:652

Jedes deklarierte Potenzial auf diesem Knoten, verschlüsselt durch Pivot-ID.

Rückgabewert

Map<string, number>

---

getSources()

getSources(): string[]

Definiert in: Node.ts:538

Die Quellen, die für diesen Knoten bürgen – Pivot-IDs, plus 'seed' für Daten, die von Anfang an hier waren. Ein Knoten kann von mehreren Pivots gleichzeitig bestätigt werden und graph.removeBySource löscht ihn nur, wenn der letzte geht.

Rückgabewert

string[]

---

getStyle()

getStyle(): Partial<NodeStyle>

Definiert in: Node.ts:207

Rufen Sie die Daten des Knotens ab.

Rückgabewert

Partial<NodeStyle>

---

hasChildren()

hasChildren(): boolean

Definiert in: Node.ts:723

Rückgabewert

boolean

---

hasSource()

hasSource(source): boolean

Definiert in: Node.ts:543

Ob source für diesen Knoten bürgt. 'seed' gilt für nicht-pivotierte Daten.

Parameter

source

string

Rückgabewert

boolean

---

hide()

hide(): void

Definiert in: Node.ts:360

Rückgabewert

void

---

markAsChild()

markAsChild(parentNode, childrenDepth): void

Definiert in: Node.ts:727

Parameter

parentNode

Node

childrenDepth

number

Rückgabewert

void

---

markAsParent()

markAsParent(): void

Definiert in: Node.ts:733

Rückgabewert

void

---

removeChildById()

removeChildById(id): Node | undefined

Definiert in: Node.ts:698

Löschen Sie ein Kind und damit seinen eigenen Unterbaum. Gibt das entfernte untergeordnete Element zurück, damit der Aufrufer nach seinen Nachkommen aufräumen kann.

Parameter

id

string

Rückgabewert

Node | undefined

---

setBorderBox()

setBorderBox(width, height): void

Definiert in: Node.ts:505

Erklären Sie, dass der Rand des Knotens das zentrierte width×height-Rechteck ist, als das er tatsächlich gerendert wird, sodass die Kanten darauf und nicht auf dem Begrenzungskreis enden. Nennen Sie es after setCircleRadius, wodurch es gelöscht wird.

Parameter

width

number

height

number

Rückgabewert

void

---

setChildren()

setChildren(children): void

Definiert in: Node.ts:656

Parameter

children

Node[]

Rückgabewert

void

---

setCircleRadius()

setCircleRadius(radius): void

Definiert in: Node.ts:460

Legen Sie den Kreisradius des Knotens fest. Löscht außerdem alle gemessenen rechteckigen Ränder: Der Radius ist die gröbere Tatsache, sodass jeder Aufrufer, der die Größe eines Knotens ändert, die Verankerung standardmäßig korrekt beibehält und nur die Schubladen, die die gerenderte Form kennen, sich bis setBorderBox wieder anmelden.

Parameter

radius

number

Rückgabewert

void

---

setCircleRadiusCollapsed()

setCircleRadiusCollapsed(radius): void

Definiert in: Node.ts:469

Parameter

radius

number

Rückgabewert

void

---

setData()

setData(newData): void

Definiert in: Node.ts:137

Aktualisieren Sie die Daten des Knotens.

Parameter

newData

NodeData

Neue Daten zum Festlegen

Rückgabewert

void

---

setLayoutSize()

setLayoutSize(halfWidth): void

Definiert in: Node.ts:482

Deklarieren Sie die Box, die dieser Knoten im Layout reserviert, als halbe Breite in Diagrammeinheiten. Im Gegensatz zu setCircleRadius ist dies konstant: Die Zeichnung kann sich darin ändern, ohne dass sich etwas bewegt.

Parameter

halfWidth

number | undefined

Rückgabewert

void

---

setPotential()

Anrufsignatur

setPotential(count): void

Definiert in: Node.ts:627

Geben Sie an, wie viel mehr es für diesen Knoten gibt, ohne danach zu fragen – was das Felgenabzeichen anzeigt. 0 löscht die Deklaration.

Bei einer Pivot-ID handelt es sich um die Nummer dieses Pivots, und sein Abzeichen öffnet diesen Pivot. Bei einer reinen Zählung handelt es sich um die Summe über alles, also die Zahl, die das Felgenabzeichen 'summary' bevorzugt – die Zahl, die anzugeben ist, wenn es mehr Anbieter gibt, als eine Felge jemals benennen könnte.

Markiert den Knoten wie jeden anderen Setter hier als schmutzig, sodass das Abzeichen beim nächsten Rendern angezeigt wird – rufen Sie graph.renderer.update() auf, wenn nichts anderes in der Nähe ist.

node.setPotential('correlations', 2143) // this provider has this much
node.setPotential(2199)                 // everything has this much

Parameter

count

number

Rückgabewert

void

Anrufsignatur

setPotential(pivotId, count): void

Definiert in: Node.ts:628

Geben Sie an, wie viel mehr es für diesen Knoten gibt, ohne danach zu fragen – was das Felgenabzeichen anzeigt. 0 löscht die Deklaration.

Bei einer Pivot-ID handelt es sich um die Nummer dieses Pivots, und sein Abzeichen öffnet diesen Pivot. Bei einer reinen Zählung handelt es sich um die Summe über alles, also die Zahl, die das Felgenabzeichen 'summary' bevorzugt – die Zahl, die anzugeben ist, wenn es mehr Anbieter gibt, als eine Felge jemals benennen könnte.

Markiert den Knoten wie jeden anderen Setter hier als schmutzig, sodass das Abzeichen beim nächsten Rendern angezeigt wird – rufen Sie graph.renderer.update() auf, wenn nichts anderes in der Nähe ist.

node.setPotential('correlations', 2143) // this provider has this much
node.setPotential(2199)                 // everything has this much

Parameter

pivotId

string

count

number

Rückgabewert

void

---

setStyle()

setStyle(newStyle): void

Definiert in: Node.ts:215

Aktualisieren Sie die Daten des Knotens.

Parameter

newStyle

Partial<NodeStyle>

Neue Daten zum Festlegen

Rückgabewert

void

---

show()

show(): void

Definiert in: Node.ts:356

Rückgabewert

void

---

toDict()

toDict(dataOnly): Record<string, unknown>

Definiert in: Node.ts:239

Konvertieren Sie den Knoten in eine einfache JSON-Objektdarstellung.

Parameter

dataOnly

boolean = false

Standard: false

Rückgabewert

Record<string, unknown>

---

toggleExpand()

toggleExpand(expanded?): void

Definiert in: Node.ts:364

Parameter

expanded?

boolean

Rückgabewert

void

---

toggleVisibility()

toggleVisibility(visible): void

Definiert in: Node.ts:347

Parameter

visible

boolean

Rückgabewert

void

---

toSimulationDTO()

toSimulationDTO(): SimulationNodeDTO

Definiert in: Node.ts:267

Strukturiert klonbare Nutzlast für den Simulationsarbeiter (keine lebenden übergeordneten/untergeordneten/_Untergraph-Referenzen, im Gegensatz zu clone()). Der Stil ist frei von Funktionen: Jeder auflösbare Kanal kann einen enthalten, und keine Kraft liest sie, sodass das Senden nur das Risiko eines DataCloneError mit sich bringt.

Rückgabewert

SimulationNodeDTO

---

unfreeze()

unfreeze(): void

Definiert in: Node.ts:341

Rückgabewert

void

---

unionChildren()

unionChildren(children): Node[]

Definiert in: Node.ts:674

children nach ID zusammenführen: Neue werden hinzugefügt, passende bleiben unberührt – ihre eigenen untergeordneten Elemente werden der Reihe nach zusammengeführt – und keines wird jemals entfernt. Bei der Vereinigung handelt es sich darum, wie ein Pivot, der einen Container wiederentdeckt, das Gefundene hinzufügt, ohne das bereits Vorhandene zu stören.

Parameter

children

Node[]

Rückgabewert

Node[]

jeden neu hinzugefügten Knoten in beliebiger Tiefe, sodass der Anrufer ihn registrieren und markieren kann.

---

updateData()

updateData(partialData): void

Definiert in: Node.ts:147

Teildaten mit den aktuellen Knotendaten zusammenführen. Nützlich, um nur Teile der Daten zu aktualisieren.

Parameter

partialData

Partial<NodeData>

Teildatenobjekt zum Zusammenführen

Rückgabewert

void

---

updateStyle()

updateStyle(partialStyle): void

Definiert in: Node.ts:225

Teildaten mit den aktuellen Knotendaten zusammenführen. Nützlich, um nur Teile der Daten zu aktualisieren.

Parameter

partialStyle

Partial<NodeStyle>

Teildatenobjekt zum Zusammenführen

Rückgabewert

void

Eigenschaften

children

children: Node[]

Definiert in: Node.ts:45

---

childrenDepth

childrenDepth: number

Definiert in: Node.ts:64

---

defaultCircleRadius

defaultCircleRadius: number = 10

Definiert in: Node.ts:49

---

domID

readonly domID: string

Definiert in: Node.ts:101

---

expanded?

optional expanded: boolean

Definiert in: Node.ts:61

---

frozen?

optional frozen: boolean

Definiert in: Node.ts:59

---

fx?

optional fx: number

Definiert in: Node.ts:56

---

fy?

optional fy: number

Definiert in: Node.ts:57

---

id

readonly id: string

Definiert in: Node.ts:43

---

isChild

isChild: boolean

Definiert in: Node.ts:63

True, wenn dieser Knoten ein untergeordneter Knoten innerhalb eines reduzierten Clusters ist

---

isParent

isParent: boolean

Definiert in: Node.ts:66

True, wenn dieser Knoten untergeordnete Knoten hat

---

parentNode?

optional parentNode: Node

Definiert in: Node.ts:68

Verweis auf den übergeordneten Clusterknoten (wenn dieser Knoten ein untergeordneter Knoten ist)

---

visible

visible: boolean

Definiert in: Node.ts:60

---

vx?

optional vx: number

Definiert in: Node.ts:54

---

vy?

optional vy: number

Definiert in: Node.ts:55

---

weight?

optional weight: number

Definiert in: Node.ts:58

---

x?

optional x: number

Definiert in: Node.ts:52

---

y?

optional y: number

Definiert in: Node.ts:53