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

Jetés

Erreur si un nœud avec le même id existe déjà. Déclenche onChange une fois le nœud ajouté avec succès.

addNote()

addNote(n): Note | undefined

Défini dans : Graph.ts:1265

Ajoute une note au graphique et la dessine. Prend les mêmes options que data.notes (ce que Note.toJSON renvoie), ou un Note. Émet noteAdd.

Paramètres

n

Note | NoteOptions

Renvoie

Note | undefined

la note, ou undefined tandis que UI.notes.enabled est false.

Jetés

Erreur si une note avec le même id existe déjà.

addToSelection()

addToSelection(nodes): void

Défini dans : Graph.ts:1637

Ajoute des nœuds à la sélection actuelle, laissant ce qui est déjà sélectionné en place. Les nœuds déjà sélectionnés sont ignorés.

Nœuds uniquement : la couche d'interaction n'a pas de paramètre additif pour les bords, qui ne peuvent être sélectionnés que dans leur ensemble via selectElements.

Paramètres

nodes

Les Node à ajouter.

Renvoie

void

clearEmphasis()

clearEmphasis(): void

Défini dans : Graph.ts:1726

Terminez l'accentuation emphasiseElements démarrée : le canevas se lit à nouveau normalement.

Renvoie

void

clearForecast()

clearForecast(): void

Défini dans : Graph.ts:1745

Baissez les prévisions.

Renvoie

void

clearHighlightedElements()

clearHighlightedElements(): void

Défini dans : Graph.ts:1707

Supprimez toute classe de surbrillance de tous les nœuds ou bords

Renvoie

void

closeTable()

closeTable(): void

Défini dans : Graph.ts:1669

Ferme le dock de données.

Renvoie

void

deselectAll()

deselectAll(): void

Défini dans : Graph.ts:1681

Tout désélectionner

Renvoie

void

destroy()

destroy(): void

Défini dans : Graph.ts:1444

Détruisez tous les composants de l'interface utilisateur.

Renvoie

void

edgeVisibilityChanged()

edgeVisibilityChanged(): void

Défini dans : Graph.ts:1388

Repeindre après un changement de couche de bord. Délibérément pas onChange : les couches ne touchent pas la force de liaison (voir Simulation.getActiveEdges), donc redémarrer la simulation déplacerait le graphique sans raison.

Renvoie

void

emphasiseElements()

emphasiseElements(elements): void

Défini dans : Graph.ts:1721

Choisissez un ensemble d'éléments hors du graphique : ils conservent l'apparence qu'ils ont déjà tandis que tout le reste sur le canevas s'assombrit, jusqu'à clearEmphasis. C'est ainsi que le survol d'une entrée de légende lit sa catégorie hors du canevas.

Où highlightElement pointe vers un élément, cela décrit un groupe. Les éléments qui ne sont pas dessinés pour le moment sont ignorés et un ensemble vide n'assombrit rien.

Paramètres

elements

(Node | Edge)[]

Les Node et les Edge à souligner.

Renvoie

void

focusElement()

focusElement(element): void

Défini dans : Graph.ts:1583

Met en évidence le nœud ou le bord spécifié dans la vue graphique. Un nœud caché dans un cluster ou un groupe fermé met en évidence ce cluster ou ce groupe.

Paramètres

element

Le Node ou le Edge pour se concentrer.

Node | Edge | Note

Renvoie

void

getAppID()

getAppID(): string

Défini dans : Graph.ts:1456

L'identifiant de l'application

Renvoie

string

getConnectedNodes()

getConnectedNodes(node): Node[]

Défini dans : Graph.ts:1241

Récupère tous les nœuds directement connectés à partir du nœud donné.

Renvoie les nœuds clonés pour empêcher les modifications externes.

Paramètres

node

Le nœud ou l'ID de nœud à partir duquel rechercher les connexions.

string | Node

Renvoie

Un tableau d'objets Node directement connectés à partir du nœud donné.

getEdge()

getEdge(id): Edge | undefined

Défini dans : Graph.ts:1036

Récupère une arête du graphique par son ID.

Renvoie un clone profond du bord pour empêcher les mutations externes.

Paramètres

id

string

L’ID du bord.

Renvoie

Edge | undefined

Un Edge cloné s'il est trouvé, sinon undefined.

getEdgeCount()

getEdgeCount(): number

Défini dans : Graph.ts:1086

Renvoie le nombre d'arêtes actuellement dans le graphique.

Renvoie

number

Le nombre total de bords.

getEdges()

getEdges(): Edge[]

Défini dans : Graph.ts:1168

Récupère toutes les arêtes du graphique.

Renvoie des clones des bords pour empêcher les modifications externes.

Renvoie

Un tableau d'objets Edge clonés.

getEdgesFromNode()

getEdgesFromNode(node): Edge[]

Défini dans : Graph.ts:1211

Recherche toutes les arêtes provenant d'un nœud donné.

Renvoie les bords clonés pour empêcher les modifications externes.

Paramètres

node

Le nœud ou l'ID de nœud à partir duquel rechercher les bords sortants.

string | Node

Renvoie

Un tableau d'objets Edge dont le nœud from correspond à la requête.

getEdgesToNode()

getEdgesToNode(node): Edge[]

Défini dans : Graph.ts:1226

Recherche toutes les arêtes pointant vers un nœud donné.

Renvoie les bords clonés pour empêcher les modifications externes.

Paramètres

node

Le nœud ou l'ID de nœud vers lequel rechercher les bords entrants.

string | Node

Renvoie

Un tableau d'objets Edge dont le nœud to correspond à la requête.

getGraphDepth()

getGraphDepth(): number

Défini dans : Graph.ts:1566

Renvoie

number

getMutableEdge()

getMutableEdge(id): Edge | undefined

Défini dans : Graph.ts:1052

Récupère une arête du graphique par son ID.

Renvoie l'instance Edge réelle, permettant des modifications directes.

Avertissement : La modification directe des bords à l'aide de cette méthode peut entraîner un comportement inattendu. Il est généralement plus sûr d'utiliser getEdge qui renvoie une instance clonée.

Paramètres

id

string

L’ID du bord.

Renvoie

Edge | undefined

Le Edge si trouvé, sinon le undefined.

getMutableEdges()

getMutableEdges(): Edge[]

Défini dans : Graph.ts:1184

Récupère toutes les arêtes du graphique.

Renvoie les instances Edge réelles, permettant des modifications directes.

Renvoie

Un tableau d'objets Edge.

Remarques

⚠️ Avertissement : La modification directe des bords peut entraîner un comportement inattendu. Utilisez plutôt getEdges pour travailler avec des clones sûrs.

getMutableNode()

getMutableNode(id): Node | undefined

Défini dans : Graph.ts:943

Récupère un nœud du graphique par son ID.

Renvoie l'instance de nœud réelle, permettant des modifications directes.

Avertissement : La modification directe des nœuds à l'aide de cette méthode peut entraîner un comportement inattendu. Il est généralement plus sûr d'utiliser getNode qui renvoie une instance clonée.

Paramètres

id

L'ID du nœud ou un objet Node.

string | Node

Renvoie

Node | undefined

Le Node si trouvé, sinon le undefined.

getMutableNodes()

getMutableNodes(): Node[]

Défini dans : Graph.ts:1114

Récupère tous les nœuds du graphique.

Renvoie les instances de nœud réelles, permettant des modifications directes.

Renvoie

Un tableau d'objets Node.

Remarques

⚠️ Avertissement : La modification directe des nœuds peut entraîner un comportement inattendu. Il est généralement plus sûr d'utiliser getNodes, qui renvoie des instances clonées.

getMutableVisibleEdges()

getMutableVisibleEdges(): Edge[]

Défini dans : Graph.ts:1199

Récupère toutes les arêtes visibles dans le graphique.

Renvoie les instances Edge réelles, permettant des modifications directes.

Renvoie

Un tableau d'objets Edge.

Remarques

⚠️ Avertissement : La modification directe des bords peut entraîner un comportement inattendu. Utilisez plutôt getEdges pour travailler avec des clones sûrs.

getMutableVisibleNodes()

getMutableVisibleNodes(): Node[]

Défini dans : Graph.ts:1130

Récupère tous les nœuds visibles dans le graphique. Ajout récursif d'enfants visibles

Renvoie les instances de nœud réelles, permettant des modifications directes.

Renvoie

Un tableau d'objets Node.

Remarques

⚠️ Avertissement : La modification directe des nœuds peut entraîner un comportement inattendu. Il est généralement plus sûr d'utiliser getNodes, qui renvoie des instances clonées.

getNode()

getNode(id): Node | undefined

Défini dans : Graph.ts:927

Récupère un nœud du graphique par son ID.

Renvoie un clone profond du nœud pour empêcher les mutations externes.

Paramètres

id

L'ID du nœud ou un objet Node.

string | Node

Renvoie

Node | undefined

Un Node cloné s'il est trouvé, sinon undefined.

getNodeCount()

getNodeCount(): number

Défini dans : Graph.ts:1077

Renvoie le nombre de nœuds actuellement dans le graphique.

Renvoie

number

Le nombre total de nœuds.

getNodes()

getNodes(): Node[]

Défini dans : Graph.ts:1097

Récupère tous les nœuds du graphique.

Renvoie des clones des nœuds pour empêcher les modifications externes.

Renvoie

Un tableau d'objets Node clonés.

getNote()

getNote(id): Note | undefined

Défini dans : Graph.ts:1254

Paramètres

id

string

Renvoie

Note | undefined

getNotes()

getNotes(): Note[]

Défini dans : Graph.ts:1250

Renvoie

Note[]

getOptions()

getOptions(): GraphOptions

Défini dans : Graph.ts:693

Renvoie les options de configuration actuelles du graphique.

Renvoie

GraphOptions

hideNode()

hideNode(node): void

Défini dans : Graph.ts:1393

Paramètres

node

Renvoie

void

highlightElement()

highlightElement(element): void

Défini dans : Graph.ts:1690

Ajouter une classe de surbrillance au nœud ou au bord donné

Paramètres

element

Le Node ou le Edge à mettre en évidence.

Node | Edge

Renvoie

void

nextTick()

nextTick(): void

Défini dans : Graph.ts:1430

Déclenchez la prochaine mise à jour du rendu du graphique.

Renvoie

void

nextTickFor()

nextTickFor(nodes): void

Défini dans : Graph.ts:1437

Déclenchez la prochaine mise à jour du rendu du graphique pour les sujets transmis.

Paramètres

nodes

Renvoie

void

noteAdd()

noteAdd(note): void

Défini dans : Graph.ts:422

Paramètres

note

Note

Renvoie

void

noteChange()

noteChange(note): void

Défini dans : Graph.ts:425

Paramètres

note

Note

Renvoie

void

noteRemove()

noteRemove(note): void

Défini dans : Graph.ts:428

Paramètres

note

Note

Renvoie

void

off()

off<K>(event, handler): void

Défini dans : Graph.ts:258

Paramètres de type

K

K étend clé de GraphEvents

Paramètres

event

K

handler

GraphEvents[K]

Renvoie

void

on()

on<K>(event, handler): void

Défini dans : Graph.ts:251

Paramètres de type

K

K étend clé de GraphEvents

Paramètres

event

K

handler

GraphEvents[K]

Renvoie

void

openTable()

openTable(): void

Défini dans : Graph.ts:1662

Ouvre le dock de données : les lignes du graphique sous la forme d'une grille triable et sélectionnable séparée du bas du canevas. Mode full uniquement, et seulement lorsque UI.table le permet ; sinon, pas d'opération.

Le dock peut désormais contenir des volets autres que la table, ce qui amène également le volet de la table au premier plan : l'appel porte le nom de la table et devrait vous en montrer un. Atteignez le UIManager.dock ou le activateDockTab() pour parcourir la région sans cela.

Renvoie

void

removeBySource()

removeBySource(source): object

Défini dans : Graph.ts:592

Supprimez tout ce dont une source se porte garante. Un élément dont plusieurs sources se portent garantes survit, une affirmation plus légère – la même règle uniforme d'annulation du pivot suit, et la seule façon dont tout ce qu'un pivot a apporté est supprimé.

Il s'agit d'une opération avancée, et d'une entrée dans history : l'annuler remet ce qui reste et rend la revendication de la source sur ce qui est resté.

Paramètres

source

string

Un identifiant pivot, ou 'seed' pour les données qui n'ont jamais été pivotées.

Renvoie

object

Ce qui a été effectivement supprimé.

edges

edges: Edge[]

nodes

nodes: Node[]

removeEdge()

removeEdge(id): void

Défini dans : Graph.ts:1062

Supprime une arête du graphique par son ID.

Paramètres

id

string

L’ID du bord à supprimer. Déclenche onChange après la suppression du bord.

Renvoie

void

removeFromSelection()

removeFromSelection(nodes): void

Défini dans : Graph.ts:1648

Supprime les nœuds de la sélection actuelle, laissant le reste en place. Nœuds uniquement, dans les mêmes conditions que addToSelection.

Paramètres

nodes

Les Node à supprimer.

Renvoie

void

removeNode()

removeNode(id): void

Défini dans : Graph.ts:969

Supprime un nœud du graphique par son ID.

Supprime également tous les bords connectés au nœud.

Paramètres

id

string

L'ID du nœud à supprimer. Déclenche onChange après la suppression du nœud et de ses bords.

Renvoie

void

selectElement()

selectElement(element): void

Défini dans : Graph.ts:1593

Sélectionne un nœud ou une arête donnée dans le graphique. Un nœud caché dans un cluster ou un groupe fermé est toujours celui sélectionné ; la toile éclaire le cluster ou le groupe dessiné pour elle.

Paramètres

element

Le Node ou le Edge à sélectionner.

Node | Edge

Renvoie

void

selectElements()

selectElements(elements): void

Défini dans : Graph.ts:1610

Sélectionne plusieurs nœuds, ou plusieurs arêtes, en remplaçant la sélection actuelle — le pluriel selectElement, résolvant le handle rendu de chaque élément pour vous.

Les nœuds et les bords ne peuvent pas être sélectionnés ensemble (la couche d'interaction efface un type lorsque l'autre est défini), donc un tableau mixte sélectionne les nœuds et avertit.

Paramètres

elements

(Node | Edge)[]

Les Nodes ou Edges à sélectionner. Un tableau vide efface la sélection.

Renvoie

void

setData()

setData(nodes, edges, notes): void

Défini dans : Graph.ts:852

Remplace tous les nœuds et arêtes actuels du graphique par les données fournies. Efface les nœuds et les bords existants avant de définir les nouveaux. Déclenche le rappel onChange après la mise à jour.

Paramètres

nodes

Node[] = []

Tableau de nœuds à définir. La valeur par défaut est un tableau vide.

edges

Edge[] = []

Tableau d’arêtes à définir. La valeur par défaut est un tableau vide.

notes

Note[] = []

Renvoie

void

setLegend()

setLegend(config?): void

Défini dans : Graph.ts:450

Remplacez la légende du canevas au moment de l'exécution - le jumeau impératif de UI.legend. Un graphique qui a commencé sans cela est construit sur-le-champ ; false vide la légende et supprime son filtre, et true / undefined revient à en dériver un à partir de render.nodeTypeAccessor. Passez un LegendGroupOptions pour saisir le graphique sur plusieurs dimensions à la fois.

Paramètres

config?

La légende à afficher, ou false pour la supprimer.

boolean | LegendOptions | LegendGroupOptions

Renvoie

void

setNotes()

setNotes(notes): Note[]

Défini dans : Graph.ts:1282

Remplace les notes du graphique, laissant les nœuds et les arêtes seuls. Les notes correspondent par identifiant : celle déjà présente sur le canevas est mise à jour sur place, donc son dessin y reste lié, celle qui n'est pas dans notes est supprimée et une nouvelle est ajoutée.

Paramètres

notes

(Note | NoteOptions)[]

Renvoie

Note[]

les notes maintenant sur le graphique, dans l'ordre indiqué.

Jetés

Erreur si deux entrées partagent un identifiant. Rien n’est alors changé.

setVisibleNodes()

setVisibleNodes(nodes, notify): boolean

Défini dans : Graph.ts:1356

Renvoie si quelque chose a bougé, afin qu'un changement de filtre de bord uniquement puisse se repeindre. notify est désactivé pour la première passe du moteur de requête, qui s'exécute avant que quoi que ce soit ne soit dessiné – le propre simulation.update() / renderer.init() du constructeur le suit.

Paramètres

nodes

notify

boolean = true

Renvoie

boolean

showForecast()

showForecast(forecast): void

Défini dans : Graph.ts:1740

Peignez ce qu'une action * ferait * et ne changerait rien d'autre : les éléments qu'elle emporterait s'écouleraient sur place, ceux qu'elle cacherait avec eux, et tout ce qu'elle ramènerait est indiqué là où il atterrirait.

Là où emphasiseElements lit un ensemble hors du canevas en reculant le reste, une prévision répond "que se passe-t-il si je clique" - le graphique doit donc continuer à lire normalement autour des quelques éléments qui changeraient. graph.history.preview(...) renvoie un prêt à l'emploi.

Paramètres

forecast

GraphForecast

Renvoie

void

showNode()

showNode(node): void

Défini dans : Graph.ts:1404

Paramètres

node

Renvoie

void

toggleExpandNode()

toggleExpandNode(node): void

Défini dans : Graph.ts:1415

Paramètres

node

Renvoie

void

toggleExpandNodes()

toggleExpandNodes(nodes): void

Défini dans : Graph.ts:1420

Paramètres

nodes

Renvoie

void

toggleTable()

toggleTable(): void

Défini dans : Graph.ts:1674

Ouvre le dock de données s'il est fermé, le ferme s'il est ouvert.

Renvoie

void

unHighlightElement()

unHighlightElement(element): void

Défini dans : Graph.ts:1699

Supprimer une classe en surbrillance sur le nœud ou le bord donné

Paramètres

element

Le Node ou le Edge à sélectionner.

Node | Edge

Renvoie

void

updateData()

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

Défini dans : Graph.ts:764

Met à jour le graphique avec de nouveaux nœuds et/ou arêtes.

Un identifiant que le graphique contient déjà est mis à jour à la place : ce que l'élément est — ses données, son style et son poids — devient ce que vous avez remis, tandis que l'objet lui-même conserve son identité. Cela doit fonctionner de cette façon. Ses bords, la simulation et la liaison DOM contiennent tous cet objet, tout comme tout ce qu'il a appris depuis sa construction : quelles sources en témoignent, où il se trouve, s'il est épinglé. Une position sur l'élément entrant gagne toujours, donc updateData peut déplacer quelque chose ainsi que le rafraîchir. Des identifiants inconnus sont ajoutés.

Les children d'un conteneur ne sont pas restructurés ici — passez le conteneur via removeNode et addNode pour changer ce qu'il contient.

L'appel entier est un lot : un dataBatchChanged répertoriant chaque ajout et modification dans l'ordre donné, puis un nouveau rendu, quel que soit le nombre d'éléments qu'il contient.

Paramètres

newNodes?

Tableau facultatif de nœuds à mettre à jour ou à ajouter.

newEdges?