pivotick v3.0.0

---

pivotick / Nœud

Classe: Node

Défini dans : Node.ts:42

Représente un seul nœud (sommet) dans un graphique.

Accesseurs

isGroup

Signature du getter

get isGroup(): boolean

Défini dans : Node.ts:441

Vrai pour un groupe dessiné par graph.simplify : un remplaçant pour ses membres, ne faisant jamais partie des données.

Renvoie

boolean

Constructeurs

Constructeur

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

Défini dans : Node.ts:108

Créez une nouvelle instance de nœud.

Paramètres

id

string

Identifiant unique du nœud

data?

NodeData

Charge utile de données facultative associée au nœud

style?

Partial<NodeStyle>

domID?

string = ...

children?

Node[] = []

Renvoie

Node

Méthodes

ancestorChain()

ancestorChain(): Node[]

Défini dans : Node.ts:400

Les clusters du nœud, les plus extérieurs en premier — vides pour un nœud du graphe racine.

Renvoie

Node[]

---

canvasRepresentative()

canvasRepresentative(): Node

Défini dans : Node.ts:419

Le nœud que le canevas dessine réellement pour celui-ci : lui-même lorsque chaque cluster au-dessus est développé, sinon le cluster réduit le plus à l'extérieur - la boîte qui le cache - et dans les deux cas, le groupe fermé dans lequel le point est replié, le cas échéant.

Cela répond "quel point à l'écran représente ce nœud", et non "est-il visible": un cluster développé restitue un sous-graphe séparé construit à partir de toDict() données, donc un nœud imbriqué n'est jamais dessiné par ce graphe même lorsque son cluster est ouvert.

Renvoie

Node

---

clone()

clone(): Node

Défini dans : Node.ts:284

Renvoie

Node

---

collapse()

collapse(): void

Défini dans : Node.ts:388

Renvoie

void

---

degree()

degree(): number

Défini dans : Node.ts:395

Renvoie

number

---

descendants()

descendants(): Node[]

Défini dans : Node.ts:709

Chaque nœud en dessous de celui-ci, la profondeur en premier.

Renvoie

Node[]

---

expand()

expand(): void

Défini dans : Node.ts:381

Renvoie

void

---

freeze()

freeze(): void

Défini dans : Node.ts:335

Renvoie

void

---

getBorderBox()

getBorderBox(outset): NodeBorderBox | undefined

Défini dans : Node.ts:513

La bordure rectangulaire du nœud agrandie de outset, ou de undefined lorsque le nœud est ancré sous forme de cercle.

Paramètres

outset

number = 0

Renvoie

NodeBorderBox | undefined

---

getBorderDistance()

getBorderDistance(dirX, dirY, outset): number

Défini dans : Node.ts:525

Distance du centre du nœud à sa frontière le long de la direction unitaire (dirX, dirY), augmentée de outset — où devrait commencer un bord partant dans cette direction. Rectangulaire pour un nœud mesuré, le rayon du cercle sinon. Délibérément exempt de résolution de style : cela s'applique aux deux extrémités de chaque arête à chaque tick.

Paramètres

dirX

number

dirY

number

outset

number = 0

Renvoie

number

---

getCircleRadius()

getCircleRadius(): number

Défini dans : Node.ts:465

Renvoie

number

---

getCircleRadiusCollapsed()

getCircleRadiusCollapsed(): number

Défini dans : Node.ts:473

Renvoie

number

---

getConnectedNodes()

getConnectedNodes(): Node[]

Défini dans : Node.ts:184

Renvoie

Node[]

---

getConnectingNodes()

getConnectingNodes(): Node[]

Défini dans : Node.ts:190

Renvoie

Node[]

---

getData()

getData(): NodeData

Défini dans : Node.ts:129

Obtenez les données du nœud.

Renvoie

NodeData

---

getEdgesIn()

getEdgesIn(): Edge[]

Défini dans : Node.ts:200

Renvoie

Edge[]

---

getEdgesOut()

getEdgesOut(): Edge[]

Défini dans : Node.ts:196

Renvoie

Edge[]

---

getGraphElement()

getGraphElement(): SVGGElement | null

Défini dans : Node.ts:230

Renvoie

SVGGElement | null

---

getLayoutRadius()

getLayoutRadius(): number

Défini dans : Node.ts:496

Le rayon du tracé espace ce nœud par : son empreinte déclarée là où il en a une, et sinon quel que soit le dessin mesuré. Chaque force lit ceci ; les tiroirs indiquent getCircleRadius, qui est la taille dessinée.

Renvoie

number

---

getLayoutSize()

getLayoutSize(): number | undefined

Défini dans : Node.ts:487

La demi-largeur de l'empreinte déclarée, ou undefined lorsque le dessin possède l'espacement.

Renvoie

number | undefined

---

getPotential()

getPotential(pivotId): number | undefined

Défini dans : Node.ts:647

Le potentiel déclaré pour un pivot, ou – sans argument – le total déclaré pour aucun pivot particulier. undefined alors qu'aucun ne l'était.

Paramètres

pivotId

string = SUMMARY_POTENTIAL

Renvoie

number | undefined

---

getPotentials()

getPotentials(): Map<string, number>

Défini dans : Node.ts:652

Chaque potentiel déclaré sur ce nœud, saisi par identifiant de pivot.

Renvoie

Map<string, number>

---

getSources()

getSources(): string[]

Défini dans : Node.ts:538

Les sources garantissant ce nœud : les identifiants pivots, plus 'seed' pour les données qui étaient là au départ. Un nœud peut être garanti par plusieurs pivots à la fois, et graph.removeBySource ne le supprime que lorsque le dernier disparaît.

Renvoie

string[]

---

getStyle()

getStyle(): Partial<NodeStyle>

Défini dans : Node.ts:207

Obtenez les données du nœud.

Renvoie

Partial<NodeStyle>

---

hasChildren()

hasChildren(): boolean

Défini dans : Node.ts:723

Renvoie

boolean

---

hasSource()

hasSource(source): boolean

Défini dans : Node.ts:543

Si source se porte garant de ce nœud. 'seed' est vrai pour les données non pivotées.

Paramètres

source

string

Renvoie

boolean

---

hide()

hide(): void

Défini dans : Node.ts:360

Renvoie

void

---

markAsChild()

markAsChild(parentNode, childrenDepth): void

Défini dans : Node.ts:727

Paramètres

parentNode

Node

childrenDepth

number

Renvoie

void

---

markAsParent()

markAsParent(): void

Défini dans : Node.ts:733

Renvoie

void

---

removeChildById()

removeChildById(id): Node | undefined

Défini dans : Node.ts:698

Supprimez un enfant et son propre sous-arbre avec lui. Renvoie l'enfant supprimé afin que l'appelant puisse nettoyer après ses descendants.

Paramètres

id

string

Renvoie

Node | undefined

---

setBorderBox()

setBorderBox(width, height): void

Défini dans : Node.ts:505

Déclarez que la bordure du nœud est le rectangle centré width×height sous lequel il est réellement rendu, de sorte que les bords s'arrêtent sur lui plutôt que sur le cercle englobant. Appelez-le after setCircleRadius, ce qui l'efface.

Paramètres

width

number

height

number

Renvoie

void

---

setChildren()

setChildren(children): void

Défini dans : Node.ts:656

Paramètres

children

Node[]

Renvoie

void

---

setCircleRadius()

setCircleRadius(radius): void

Défini dans : Node.ts:460

Définissez le rayon du cercle du nœud. Supprime également toute bordure rectangulaire mesurée : le rayon est le fait le plus grossier, donc chaque appelant qui redimensionne un nœud conserve l'ancrage correct par défaut, et seuls les tiroirs qui connaissent la forme rendue se réinscrivent via setBorderBox.

Paramètres

radius

number

Renvoie

void

---

setCircleRadiusCollapsed()

setCircleRadiusCollapsed(radius): void

Défini dans : Node.ts:469

Paramètres

radius

number

Renvoie

void

---

setData()

setData(newData): void

Défini dans : Node.ts:137

Mettez à jour les données du nœud.

Paramètres

newData

NodeData

Nouvelles données à définir

Renvoie

void

---

setLayoutSize()

setLayoutSize(halfWidth): void

Défini dans : Node.ts:482

Déclarez la boîte que ce nœud réserve dans la mise en page, sous forme de demi-largeur en unités graphiques. Contrairement à setCircleRadius celui-ci est constant : le dessin peut changer à l'intérieur sans que rien ne bouge.

Paramètres

halfWidth

number | undefined

Renvoie

void

---

setPotential()

Signature d'appel

setPotential(count): void

Défini dans : Node.ts:627

Déclarez combien il y a de plus pour ce nœud, sans rien demander – ce que montre le badge de jante. 0 efface la déclaration.

Avec un identifiant de pivot, c'est le numéro de ce pivot, et son badge ouvre ce pivot. Avec un seul décompte, c'est le total pour tout, qui est le numéro que le badge de jante 'summary' préfère - celui qui déclare lorsqu'il y a plus de fournisseurs qu'une jante ne pourrait jamais en nommer.

Marque le nœud sale comme tous les autres setter ici, de sorte que le badge apparaisse lors du prochain rendu - appelez graph.renderer.update() si rien d'autre n'est sur le point de le faire.

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

Paramètres

count

number

Renvoie

void

Signature d'appel

setPotential(pivotId, count): void

Défini dans : Node.ts:628

Déclarez combien il y a de plus pour ce nœud, sans rien demander – ce que montre le badge de jante. 0 efface la déclaration.

Avec un identifiant de pivot, c'est le numéro de ce pivot, et son badge ouvre ce pivot. Avec un seul décompte, c'est le total pour tout, qui est le numéro que le badge de jante 'summary' préfère - celui qui déclare lorsqu'il y a plus de fournisseurs qu'une jante ne pourrait jamais en nommer.

Marque le nœud sale comme tous les autres setter ici, de sorte que le badge apparaisse lors du prochain rendu - appelez graph.renderer.update() si rien d'autre n'est sur le point de le faire.

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

Paramètres

pivotId

string

count

number

Renvoie

void

---

setStyle()

setStyle(newStyle): void

Défini dans : Node.ts:215

Mettez à jour les données du nœud.

Paramètres

newStyle

Partial<NodeStyle>

Nouvelles données à définir

Renvoie

void

---

show()

show(): void

Défini dans : Node.ts:356

Renvoie

void

---

toDict()

toDict(dataOnly): Record<string, unknown>

Défini dans : Node.ts:239

Convertissez le nœud en une simple représentation d'objet JSON.

Paramètres

dataOnly

boolean = false

par défaut : faux

Renvoie

Record<string, unknown>

---

toggleExpand()

toggleExpand(expanded?): void

Défini dans : Node.ts:364

Paramètres

expanded?

boolean

Renvoie

void

---

toggleVisibility()

toggleVisibility(visible): void

Défini dans : Node.ts:347

Paramètres

visible

boolean

Renvoie

void

---

toSimulationDTO()

toSimulationDTO(): SimulationNodeDTO

Défini dans : Node.ts:267

Charge utile structurée et clonable pour le travailleur de simulation (pas de références parent/enfants/_subgraph live, contrairement à clone()). Le style est dépourvu de fonctions : chaque canal résoluble peut en contenir une, et aucune force ne les lit, donc leur envoyer ne risque qu'un DataCloneError.

Renvoie

SimulationNodeDTO

---

unfreeze()

unfreeze(): void

Défini dans : Node.ts:341

Renvoie

void

---

unionChildren()

unionChildren(children): Node[]

Défini dans : Node.ts:674

Fusionner children par identifiant : de nouveaux sont ajoutés, ceux qui correspondent restent intacts - leurs propres enfants fusionnés à leur tour - et aucun n'est jamais supprimé. L'union est la façon dont un pivot redécouvre un conteneur ajoute ce qu'il a trouvé sans perturber ce qui est déjà là.

Paramètres

children

Node[]

Renvoie

Node[]

chaque nœud nouvellement ajouté, à n'importe quelle profondeur, afin que l'appelant puisse les enregistrer et les étiqueter.

---

updateData()

updateData(partialData): void

Défini dans : Node.ts:147

Fusionnez les données partielles dans les données du nœud actuel. Utile pour mettre à jour uniquement certaines parties des données.

Paramètres

partialData

Partial<NodeData>

Objet de données partiel à fusionner

Renvoie

void

---

updateStyle()

updateStyle(partialStyle): void

Défini dans : Node.ts:225

Fusionnez les données partielles dans les données du nœud actuel. Utile pour mettre à jour uniquement certaines parties des données.

Paramètres

partialStyle

Partial<NodeStyle>

Objet de données partiel à fusionner

Renvoie

void

Propriétés

children

children: Node[]

Défini dans : Node.ts:45

---

childrenDepth

childrenDepth: number

Défini dans : Node.ts:64

---

defaultCircleRadius

defaultCircleRadius: number = 10

Défini dans : Node.ts:49

---

domID

readonly domID: string

Défini dans : Node.ts:101

---

expanded?

optional expanded: boolean

Défini dans : Node.ts:61

---

frozen?

optional frozen: boolean

Défini dans : Node.ts:59

---

fx?

optional fx: number

Défini dans : Node.ts:56

---

fy?

optional fy: number

Défini dans : Node.ts:57

---

id

readonly id: string

Défini dans : Node.ts:43

---

isChild

isChild: boolean

Défini dans : Node.ts:63

Vrai si ce nœud est un enfant dans un cluster réduit

---

isParent

isParent: boolean

Défini dans : Node.ts:66

Vrai si ce nœud a des nœuds enfants

---

parentNode?

optional parentNode: Node

Défini dans : Node.ts:68

Référence au nœud du cluster parent (si ce nœud est un enfant)

---

visible

visible: boolean

Défini dans : Node.ts:60

---

vx?

optional vx: number

Défini dans : Node.ts:54

---

vy?

optional vy: number

Défini dans : Node.ts:55

---

weight?

optional weight: number

Défini dans : Node.ts:58

---

x?

optional x: number

Défini dans : Node.ts:52

---

y?

optional y: number

Défini dans : Node.ts:53