Aller au contenu

pivotick v3.0.0


pivotick / PivotManager

Interface: PivotManager ​

Défini dans : PivotManager.ts:50

Le runtime pivot : le registre, les deux appels du fournisseur avec leur annulation et leur cache, la porte de rétrécissement, les ensembles candidats en attente de tri et l'ingestion avec sa provenance. Revenir en arrière est le travail de graph.history, aux côtés de tout ce que l'analyste peut inverser.

Il ne contient aucune interface utilisateur. Tout ici est pilotable depuis la console — un pivot avec autoIngest: true est bout à bout sans un seul volet — et le volet de triage et le mode ferroviaire Pivot sont des lecteurs de cet état, pas des propriétaires de celui-ci.

Atteint sous la forme Graph.pivots.

Outils ​

Accesseurs ​

rimBadge ​

Signature du getter ​

get rimBadge(): PivotRimBadge

Défini dans : PivotManager.ts:111

Ce que la bibliothèque dessine sur le bord d'un nœud pour ses pivots : un badge par pivot qui a déclaré un potentiel, un badge pour tous, ou rien. Définissez-le via pivotRimBadge dans les options du graphique, ou ici pour le modifier plus tard.

L'attribution marque chaque nœud comme sale, comme le fait setPotential pour un seul - le bord est redessiné lors du prochain rendu, alors appelez graph.renderer.update() si rien d'autre n'est sur le point de le faire.

Renvoie ​

PivotRimBadge

Signature du setter ​

set rimBadge(mode): void

Défini dans : PivotManager.ts:115

Ce que la bibliothèque dessine sur le bord d'un nœud pour ses pivots.

Paramètres ​
mode ​

PivotRimBadge

Renvoie ​

void

Implémentation de ​

PivotManagerLike.rimBadge


rimBadgeShown ​

Signature du getter ​

get rimBadgeShown(): boolean

Défini dans : PivotManager.ts:142

Si les badges de jante sont dessinés en ce moment.

Renvoie ​

boolean


rimBadgeVisible ​

Signature du getter ​

get rimBadgeVisible(): PivotRimBadgeVisibility

Défini dans : PivotManager.ts:131

Lorsque les badges de jante de rimBadge sont dessinés : uniquement lorsque le mode Pivot est ouvert, toujours ou jamais. Définissez-le via pivotRimBadgeVisible dans les options du graphique, ou ici pour le modifier plus tard.

Comme rimBadge, l'attribution marque chaque nœud comme sale.

Renvoie ​

PivotRimBadgeVisibility

Signature du setter ​

set rimBadgeVisible(visibility): void

Défini dans : PivotManager.ts:135

Quand ces insignes de jante seront dessinés.

Paramètres ​
visibility ​

PivotRimBadgeVisibility

Renvoie ​

void

Implémentation de ​

PivotManagerLike.rimBadgeVisible


saveControls ​

Signature du getter ​

get saveControls(): boolean

Défini dans : PivotManager.ts:90

Si le panneau Pivot et le volet de tri proposent leur propre N non enregistré · Enregistrer. Désactivé, un consommateur répond uniquement via save, qui, comme le grand livre et unsavedCount, fonctionne dans les deux sens. Définissez-le via pivotSaveControls dans les options du graphique, ou ici pour le modifier plus tard.

Renvoie ​

boolean

Signature du setter ​

set saveControls(shown): void

Défini dans : PivotManager.ts:94

Si le panneau Pivot et le volet de tri proposent leur propre sauvegarde.

Paramètres ​
shown ​

boolean

Renvoie ​

void

Implémentation de ​

PivotManagerLike.saveControls


size ​

Signature du getter ​

get size(): number

Défini dans : PivotManager.ts:272

Combien de pivots sont enregistrés — ce que lit le déclenchement du mode rail Pivot.

Renvoie ​

number

Méthodes ​

all() ​

all(): PivotDefinition[]

Défini dans : PivotManager.ts:267

Chaque pivot inscrit, dans l'ordre d'inscription.

Renvoie ​

PivotDefinition[]

Implémentation de ​

PivotManagerLike.all


applicableCount() ​

applicableCount(node): number

Défini dans : PivotManager.ts:301

Combien de pivots s'appliquent à un nœud - ce que compte le badge de jante 'summary' lorsque rien n'a été déclaré pour celui-ci.

Mémorisé, car le rim demande cela pour chaque nœud à chaque rendu et la réponse est un appel appliesTo par pivot enregistré : chez une centaine de fournisseurs et un millier de nœuds, demander à chaque fois équivaut à cent mille appels par image. Le mémo est supprimé chaque fois que le registre ou les nœuds du graphique changent, donc un prédicat lisant n'importe quoi else peut devenir obsolète - acceptable pour un indice sur le bord, et le panneau est toujours la réponse exacte.

Paramètres ​

node ​

Node

Renvoie ​

number

Implémentation de ​

PivotManagerLike.applicableCount


cachedSummary() ​

cachedSummary(id, nodes, narrowing): PivotSummary | undefined

Défini dans : PivotManager.ts:379

Le résumé en cache pour exactement cette question, s'il y en a un. Permet à une surface de peindre un numéro qu'elle connaît déjà sans le demander à nouveau.

Paramètres ​

id ​

string

nodes ​

Node[] = []

narrowing ​

PivotNarrowing = {}

Renvoie ​

PivotSummary | undefined


cancel() ​

cancel(pivotId?, kind?): void

Défini dans : PivotManager.ts:409

Abandonnez les appels du fournisseur en cours : un pivot ou tous les pivots, et éventuellement un seul type.

Le kind est ce qui permet de quitter une surface pour arrêter les questions qu'elle posait sans annuler le travail qu'elle a commandé - un fetch a déjà son propre ensemble de candidats et un volet le montrant, donc l'abandonner silencieusement rejetterait les résultats que personne n'a demandé de perdre.

Paramètres ​

pivotId? ​

string

kind? ​

"summarize" | "fetch"

Renvoie ​

void

Implémentation de ​

PivotManagerLike.cancel


cancelFetch() ​

cancelFetch(pivotId): void

Défini dans : PivotManager.ts:631

Annuler une récupération en vol. L’ensemble des candidats va avec ; rien n'est mis en scène.

Paramètres ​

pivotId ​

string

Renvoie ​

void


candidates() ​

candidates(pivotId): PivotCandidateSet | undefined

Défini dans : PivotManager.ts:701

Les candidats se sont mis en scène pour un pivot, le cas échéant.

Paramètres ​

pivotId ​

string

Renvoie ​

PivotCandidateSet | undefined


canonicalId() ​

canonicalId(element): string | undefined

Défini dans : PivotManager.ts:1254

L'identifiant que le système source a attribué à cet élément, lorsqu'il en a attribué un.

Paramètres ​

element ​

Node | Edge

Renvoie ​

string | undefined

Implémentation de ​

PivotManagerLike.canonicalId


discard() ​

discard(pivotId): void

Défini dans : PivotManager.ts:846

Abandonnez un décor mis en scène sans rien rejeter. Fermer un volet n'est pas un verdict : ce qui n'a jamais été rejeté est à nouveau proposé lors de l'exécution suivante.

Paramètres ​

pivotId ​

string

Renvoie ​

void


dismissPending() ​

dismissPending(pivotId): void

Défini dans : PivotManager.ts:833

Laissez tomber une rediffusion en attente et continuez avec ce qui est présenté. Rien n'est rejeté : le prochain tour propose à nouveau ces candidats.

Paramètres ​

pivotId ​

string

Renvoie ​

void

Implémentation de ​

PivotManagerLike.dismissPending


for() ​

for(nodes): PivotDefinition[]

Défini dans : PivotManager.ts:285

Ce qui s'applique à cette origine. Une origine vide donne les pivots sans origine (recherche, importation, transfert) et rien d'autre, car un pivot basé sur la sélection sans sélection n'a rien sur quoi s'exécuter.

Un pivot qui s'applique uniquement à la partie de l'origine est présent : une sélection mélangeant un domaine et une IP propose également les fournisseurs de domaine uniquement, et chacun est exécuté sur les nœuds qu'il a conservés.

Paramètres ​

nodes ​

Node[]

Renvoie ​

PivotDefinition[]

Implémentation de ​

PivotManagerLike.for


get() ​

get(id): PivotDefinition | undefined

Défini dans : PivotManager.ts:262

Paramètres ​

id ​

string

Renvoie ​

PivotDefinition | undefined

Implémentation de ​

PivotManagerLike.get


ingest() ​

ingest(pivotId, trigger, options): Promise<PivotRunOutcome>

Défini dans : PivotManager.ts:864

Engagez les candidats marqués d’un ensemble mis en scène.

Purement additif : un identifiant déjà sur le canevas est ignoré, jamais écrasé, et la suppression ne se produit que via graph.history ou graph.removeBySource. L'ensemble du lot passe par onBeforeIngest une fois et atterrit comme un dataBatchChanged.

group plie l'atterrissage en groupes, un par type (graph.simplify.groupLanding), et la valeur par défaut est ingestGrouped.

Paramètres ​

pivotId ​

string

trigger ​

"auto" | "triage"

options ​
group? ​

boolean

Renvoie ​

Promise<PivotRunOutcome>


invalidate() ​

invalidate(pivotId?, nodes?): void

Défini dans : PivotManager.ts:389

Supprimez les résumés mis en cache : tous, ceux d'un pivot ou uniquement ceux posés sur des nœuds particuliers. La bibliothèque est mise en cache car un résumé à sélection multiple est un agrégat que rien ne peut décomposer, mais seul le consommateur sait quand son backend a changé.

Paramètres ​

pivotId? ​

string

nodes? ​

Node[]

Renvoie ​

void

Implémentation de ​

PivotManagerLike.invalidate


isSavable() ​

isSavable(element): boolean

Défini dans : PivotManager.ts:1247

Si cet élément provient d'une course dont le pivot déclare un save.

Paramètres ​

element ​

Node | Edge

Renvoie ​

boolean

Implémentation de ​

PivotManagerLike.isSavable


isSaved() ​

isSaved(element): boolean

Défini dans : PivotManager.ts:1242

Écrit sur le système source. false à la fois pour un élément toujours en attente et pour celui dont le pivot ne peut jamais l'écrire nulle part — isSavable est la question qui distingue ces deux-là.

Paramètres ​

element ​

Node | Edge

Renvoie ​

boolean

Implémentation de ​

PivotManagerLike.isSaved


mark() ​

mark(pivotId, id, marked): void

Défini dans : PivotManager.ts:715

Marquez ou décochez un candidat à ingérer. Délibérément silencieux : avec des centaines de lignes, le rendu du volet à chaque tick fait perdre la place de l'analyste, donc l'appelant met à jour la ligne qu'il vient de modifier.

Paramètres ​

pivotId ​

string

id ​

string

marked ​

boolean = true

Renvoie ​

void


markAll() ​

markAll(pivotId, marked): void

Défini dans : PivotManager.ts:722

Marquez chaque candidat réalisable – ce à quoi « tout sélectionner » résout.

Paramètres ​

pivotId ​

string

marked ​

boolean = true

Renvoie ​

void


on() ​

on(listener): () => void

Défini dans : PivotManager.ts:1581

Abonnez-vous aux changements d'état pivot : le registre, un résumé, les candidats par étapes, la pile d'exécution. Renvoie un broyeur.

Paramètres ​

listener ​

(change) => void

Renvoie ​

(): void

Renvoie ​

void


originFor() ​

originFor(id, nodes): Node[]

Défini dans : PivotManager.ts:313

À quelle quantité de nodes un pivot s'applique. Vide quand il ne s'applique pas, et vide pour un pivot sans origine, qui n'est interrogé sur rien par définition.

Paramètres ​

id ​

string

nodes ​

Node[]

Renvoie ​

Node[]

Implémentation de ​

PivotManagerLike.originFor


register() ​

register(definition): () => void

Défini dans : PivotManager.ts:229

Enregistrez un pivot. Renvoie un broyeur ; l'appeler deux fois est un échec. Un identifiant en double est ignoré avec un avertissement, comme partout ailleurs dans la bibliothèque.

Paramètres ​

definition ​

PivotDefinition

Renvoie ​

(): void

Renvoie ​

void

Implémentation de ​

PivotManagerLike.register


reject() ​

reject(pivotId, ids): void

Défini dans : PivotManager.ts:741

Rejetez explicitement les candidats. Mémorisé pour la séance, saisi par pivot : un candidat rejeté sous un pivot est toujours proposé par un autre, qui le questionne dans un contexte analytique différent.

Paramètres ​

pivotId ​

string

ids ​

string[]

Renvoie ​

void


rejectedCount() ​

rejectedCount(pivotId): number

Défini dans : PivotManager.ts:791

Combien de candidats ont été rejetés pour ce pivot cette session.

Paramètres ​

pivotId ​

string

Renvoie ​

number


rejectedIds() ​

rejectedIds(pivotId): string[]

Défini dans : PivotManager.ts:796

Le candidat rejeté identifie ce pivot – ce que le volet révèle à la demande.

Paramètres ​

pivotId ​

string

Renvoie ​

string[]


rejectedRows() ​

rejectedRows(pivotId): PivotRejection[]

Défini dans : PivotManager.ts:804

Les rejets eux-mêmes, lignes et tout, les plus récents en dernier. Quelle surface les énumérant montre : un identifiant ne nomme plus rien une fois que la course qui le portait a disparu.

Paramètres ​

pivotId ​

string

Renvoie ​

PivotRejection[]


rejectRemaining() ​

rejectRemaining(pivotId): void

Défini dans : PivotManager.ts:769

Rejetez tout ce qui n'a pas encore été trié dans cet ensemble - comment trier 1 800 jusqu'à 12 et rejeter le reste reste un geste.

Paramètres ​

pivotId ​

string

Renvoie ​

void


run() ​

run(id, nodes, narrowing, options): Promise<PivotRunOutcome>

Défini dans : PivotManager.ts:428

Exécutez un pivot : comparez le nombre annoncé à son plafond, récupérez, puis obtenez les résultats (autoIngest) ou organisez-les pour le tri.

Résout dès le transfert : une exécution par étapes n'attend pas l'analyste. Le runId du résultat est l'identifiant sous lequel l'ingest résultant est enregistré, c'est donc le handle pour graph.history.undo.

Paramètres ​

id ​

string

nodes ​

Node[] = []

narrowing ​

PivotNarrowing = {}

options ​

PivotRunOptions = {}

Renvoie ​

Promise<PivotRunOutcome>

Implémentation de ​

PivotManagerLike.run


save() ​

save(target?, options?): Promise<PivotSaveReport>

Défini dans : PivotManager.ts:1105

Écrivez les exécutions ingérées vers les systèmes auxquels leurs pivots communiquent : une exécution ou chaque exécution enregistrable avec quelque chose encore non enregistré.

La bibliothèque contribue à la comptabilité, pas au transport : quels éléments une exécution a créés, lesquels d'entre eux ont été écrits et ce qu'une nouvelle tentative doit contenir. L'écriture elle-même est PivotDefinition.save, et un pivot qui déclare aucun n'est entièrement ignoré plutôt que compté comme un échec.

Les exécutions se déroulent une par une : un backend en cours d'écriture n'est pas aidé par six lots parallèles, et une passe séquentielle rend le rapport exact.

Paramètres ​

target? ​

Un identifiant d'exécution pour une exécution, un identifiant de pivot pour chaque exécution non enregistrée de ce pivot, { elements } uniquement pour celles-ci, ou rien pour toutes.

string | PivotSaveSelection

options? ​

PivotSaveOptions = {}

interactive: true lorsqu'un analyste l'a demandé, afin qu'une sauvegarde puisse être demandée.

Renvoie ​

Promise<PivotSaveReport>

Implémentation de ​

PivotManagerLike.save


showPending() ​

showPending(pivotId): void

Défini dans : PivotManager.ts:820

Favoriser une rediffusion en attente : ses candidats deviennent le décor présenté, et les notes de celui qu'il remplace l'accompagnent. Une non-opération pendant que la réexécution est toujours en cours de récupération - échanger un ensemble ne contenant encore rien serait l'abandon silencieux que tout ce mécanisme existe pour éviter.

Paramètres ​

pivotId ​

string

Renvoie ​

void

Implémentation de ​

PivotManagerLike.showPending


staged() ​

staged(): PivotCandidateSet[]

Défini dans : PivotManager.ts:706

Chaque ensemble de candidats par étapes : un par pivot qui a été exécuté et non encore autorisé.

Renvoie ​

PivotCandidateSet[]


summarize() ​

summarize(id, nodes, narrowing): Promise<PivotSummary | undefined>

Défini dans : PivotManager.ts:347

Demandez à un pivot ce qui existe. Fournit une réponse en cache sans toucher au fournisseur et remplace tout résumé déjà en cours pour le même pivot.

Résout undefined lorsque l'appel a été remplacé ou annulé — rien à restituer, et jamais une erreur. Un fournisseur qui rejette l'opération, afin qu'une surface puisse afficher l'échec et proposer une nouvelle tentative.

Paramètres ​

id ​

string

nodes ​

Node[] = []

narrowing ​

PivotNarrowing = {}

Renvoie ​

Promise<PivotSummary | undefined>


unregister() ​

unregister(id): void

Défini dans : PivotManager.ts:254

Désenregistrez un pivot, en supprimant ses résumés mis en cache et ses candidats mis en scène.

Paramètres ​

id ​

string

Renvoie ​

void

Implémentation de ​

PivotManagerLike.unregister


unreject() ​

unreject(pivotId, id): void

Défini dans : PivotManager.ts:758

Reprenez un rejet. Atteint la mémoire de la session, que le candidat soit toujours mis en scène ou non : un rejet d'une exécution précédente supprime la ligne plutôt que de l'afficher, et la reprendre est le seul moyen pour que cette ligne soit à nouveau proposée.

Paramètres ​

pivotId ​

string

id ​

string

Renvoie ​

void


unrejectAll() ​

unrejectAll(pivotId): void

Défini dans : PivotManager.ts:779

Prenez chaque rejet que ce pivot retient. La sortie d'un Reject all remaining qui est allé trop loin, ce que la restauration un par un ne l'est pas.

Paramètres ​

pivotId ​

string

Renvoie ​

void


unsaved() ​

unsaved(): PivotRun[]

Défini dans : PivotManager.ts:1220

Exécutions enregistrables avec des éléments toujours sur la toile et non encore écrits.

Renvoie ​

PivotRun[]

Implémentation de ​

PivotManagerLike.unsaved


unsavedCount() ​

unsavedCount(pivotId?): object

Défini dans : PivotManager.ts:1225

Ce qu'une sauvegarde enverrait - sur chaque exécution pouvant être sauvegardée ou sur un pivot.

Paramètres ​

pivotId? ​

string

Renvoie ​

object

edges ​

edges: number

nodes ​

nodes: number

Implémentation de ​

PivotManagerLike.unsavedCount

Propriétés ​

candidateCeiling ​

candidateCeiling: number = 10_000

Défini dans : PivotManager.ts:57

Plafond absolu sur ce qu'un fetch peut mettre en scène. Un fournisseur qui renvoie plus est refusé — rien n'est mis en scène, rien n'est tronqué et l'analyste reçoit le numéro. Il s'agit de mémoire pour les objets candidats, pas de table, qui virtualise. Remplacez-le via pivotCandidateCeiling dans les options du graphique.

Implémentation de ​

PivotManagerLike.candidateCeiling


ingestGrouped ​

ingestGrouped: boolean = false

Défini dans : PivotManager.ts:73

Si un ingéré atterrit en groupes, un par type, lorsque son appelant ne le dit pas. Définissez-le via pivotIngestGrouped dans les options du graphique, ou ici pour le modifier plus tard. Ne fait rien tant que le graphique ne simplifie pas.


markUnsaved ​

markUnsaved: boolean = false

Défini dans : PivotManager.ts:80

Si un nœud créé par une exécution et n'a pas été réécrit porte une classe pvt-node-unsaved. Définissez-le via pivotMarkUnsaved dans les options du graphique, ou ici pour le modifier plus tard.


quickIngestLimit ​

quickIngestLimit: number = 50

Défini dans : PivotManager.ts:66

Combien de nouveaux candidats un pivot en un clic atterrit sans triage. Le nombre concerne le canevas plutôt que le clic : l'annulation reprend une ingestion mais pas la disposition que la simulation a faite autour de lui, donc la limite est à peu près ce qu'un graphique peut absorber tout en restant le graphique que l'analyste lisait. Remplacez-le via pivotQuickIngestLimit dans les options du graphique.

Implémentation de ​

PivotManagerLike.quickIngestLimit