Aller au contenu

pivotick v3.0.0


pivotick / Pivot / PivotManagerLike

Interface: PivotManagerLike ​

Défini dans : interfaces/Pivot.ts:621

La forme Graph.pivots expose. Déclaré comme une interface afin que la surface destinée au consommateur soit documentée en un seul endroit et que l'implémentation puisse rester interne.

Méthodes ​

all() ​

all(): PivotDefinition[]

Défini dans : interfaces/Pivot.ts:640

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

Renvoie ​

PivotDefinition[]


applicableCount() ​

applicableCount(node): number

Défini dans : interfaces/Pivot.ts:653

Combien de pivots s'appliquent à un nœud - ce que compte le badge de jante 'summary'. Tenu entre les modifications du graphique, il est donc peu coûteux de demander par nœud et par rendu.

Paramètres ​

node ​

Node

Renvoie ​

number


cancel() ​

cancel(pivotId?, kind?): void

Défini dans : interfaces/Pivot.ts:661

Abandonnez les appels en vol : un pivot ou tous, et éventuellement un seul type.

Paramètres ​

pivotId? ​

string

kind? ​

"summarize" | "fetch"

Renvoie ​

void


canonicalId() ​

canonicalId(element): string | undefined

Défini dans : interfaces/Pivot.ts:695

L'identifiant que le système source a attribué à cet élément lors de son enregistrement, lorsqu'il en a attribué un. L'élément conserve son propre identifiant - la nouvelle saisie atteint les bords, les clusters, la sélection, le moteur de requête et l'historique - donc graph.getNode(canonicalId) manque toujours et c'est la lecture qui ne le fait pas.

Paramètres ​

element ​

Node | Edge

Renvoie ​

string | undefined


dismissPending() ​

dismissPending(pivotId): void

Défini dans : interfaces/Pivot.ts:658

Supprimez une rediffusion en attente et continuez à trier ce qui est présenté.

Paramètres ​

pivotId ​

string

Renvoie ​

void


for() ​

for(nodes): PivotDefinition[]

Défini dans : interfaces/Pivot.ts:642

Ce qui s'applique à cette origine. Une origine vide donne les pivots sans origine.

Paramètres ​

nodes ​

Node[]

Renvoie ​

PivotDefinition[]


get() ​

get(id): PivotDefinition | undefined

Défini dans : interfaces/Pivot.ts:638

Paramètres ​

id ​

string

Renvoie ​

PivotDefinition | undefined


invalidate() ​

invalidate(pivotId?, nodes?): void

Défini dans : interfaces/Pivot.ts:659

Paramètres ​

pivotId? ​

string

nodes? ​

Node[]

Renvoie ​

void


isSavable() ​

isSavable(element): boolean

Défini dans : interfaces/Pivot.ts:688

Si cet élément appartient à une exécution dont le pivot peut l'écrire n'importe où.

Paramètres ​

element ​

Node | Edge

Renvoie ​

boolean


isSaved() ​

isSaved(element): boolean

Défini dans : interfaces/Pivot.ts:686

Écrit sur le système source. false pour les non sauvegardés et pour les non-sauvegardables.

Paramètres ​

element ​

Node | Edge

Renvoie ​

boolean


originFor() ​

originFor(id, nodes): Node[]

Défini dans : interfaces/Pivot.ts:648

À quelle quantité de nodes un pivot s'applique - l'origine avec laquelle il serait réellement exécuté. Vide quand il ne s'applique pas du tout, et toujours vide pour un pivot sans origine. Quelle surface lit pour dire "3 sur les 5 que vous avez choisis".

Paramètres ​

id ​

string

nodes ​

Node[]

Renvoie ​

Node[]


register() ​

register(definition): () => void

Défini dans : interfaces/Pivot.ts:636

Paramètres ​

definition ​

PivotDefinition

Renvoie ​

(): void

Renvoie ​

void


run() ​

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

Défini dans : interfaces/Pivot.ts:654

Paramètres ​

id ​

string

nodes? ​

Node[]

narrowing? ​

PivotNarrowing

options? ​

PivotRunOptions

Renvoie ​

Promise<PivotRunOutcome>


save() ​

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

Défini dans : interfaces/Pivot.ts:677

Écrivez les exécutions ingérées vers leurs systèmes sources. Les courses se déroulent une par une, et une course dont le pivot déclare non save n'en fait jamais partie.

Chaque exécution est envoyée uniquement ce qui n'est pas encore enregistré, donc une nouvelle tentative équivaut au même appel.

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, un PivotSaveSelection pour ces éléments uniquement, ou rien pour tous.

string | PivotSaveSelection

options? ​

PivotSaveOptions

interactive: true lorsqu'un analyste a demandé la sauvegarde, donc PivotSaveContext.promptData peut ouvrir son modal.

Renvoie ​

Promise<PivotSaveReport>


showPending() ​

showPending(pivotId): void

Défini dans : interfaces/Pivot.ts:656

Faites la promotion d’une rediffusion en attente sur le plateau exposé.

Paramètres ​

pivotId ​

string

Renvoie ​

void


unregister() ​

unregister(id): void

Défini dans : interfaces/Pivot.ts:637

Paramètres ​

id ​

string

Renvoie ​

void


unsaved() ​

unsaved(): PivotRun[]

Défini dans : interfaces/Pivot.ts:679

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

Renvoie ​

PivotRun[]


unsavedCount() ​

unsavedCount(pivotId?): object

Défini dans : interfaces/Pivot.ts:684

Ce qu'une sauvegarde enverrait, exacte plutôt que consultative. Rétréci aux exécutions d'un pivot lorsqu'on lui donne un identifiant - ce que compte la propre ligne d'un volet de tri.

Paramètres ​

pivotId? ​

string

Renvoie ​

object

edges ​

edges: number

nodes ​

nodes: number

Propriétés ​

candidateCeiling ​

candidateCeiling: number

Défini dans : interfaces/Pivot.ts:623

Plafond absolu sur ce qu'un fetch peut mettre en scène. Refuse plutôt que tronque.


quickIngestLimit ​

quickIngestLimit: number

Défini dans : interfaces/Pivot.ts:629

Combien de nouveaux candidats un pivot en un clic atterrit sans triage - ce que le quickPivot du gestionnaire de l'interface utilisateur passe comme PivotRunOptions.autoIngestUpTo. Une course effectuée d’une autre manière n’est pas affectée.


rimBadge ​

rimBadge: PivotRimBadge

Défini dans : interfaces/Pivot.ts:631

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


rimBadgeVisible ​

rimBadgeVisible: PivotRimBadgeVisibility

Défini dans : interfaces/Pivot.ts:633

Quand ces insignes de jante seront dessinés.


saveControls ​

saveControls: boolean

Défini dans : interfaces/Pivot.ts:635

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