Aller au contenu

pivotick v3.0.0


pivotick / Simplification

Interface: Simplification ​

Défini dans : Simplification/Simplification.ts:100

Accesseurs ​

matchQuery ​

Signature du getter ​

get matchQuery(): string | undefined

Défini dans : Simplification/Simplification.ts:551

Sur quoi les matchs ont été mis en correspondance.

Renvoie ​

string | undefined


openConfirmAbove ​

Signature du getter ​

get openConfirmAbove(): number

Défini dans : Simplification/Simplification.ts:476

Les membres au-dessus desquels Open demande en premier (UI.simplify.openConfirmAbove).

Renvoie ​

number

Méthodes ​

close() ​

close(group): void

Défini dans : Simplification/Simplification.ts:282

Repliez-y les membres d'un groupe ouvert.

Paramètres ​

group ​

GroupRef

Renvoie ​

void


colorOf() ​

colorOf(node): string

Défini dans : Simplification/Simplification.ts:513

La couleur dans laquelle un point est dessiné : UI.simplify.colorOf, sinon le style d'un nœud ou celui d'un groupe.

Paramètres ​

node ​

Node

Renvoie ​

string


defaultTitle() ​

defaultTitle(nodes): string

Défini dans : Simplification/Simplification.ts:429

L'étiquette que ces nœuds obtiendraient de leurs types, à partir de laquelle commence l'invite de titre.

Paramètres ​

nodes ​

(string | Node)[]

Renvoie ​

string


getGroups() ​

getGroups(): GroupInfo[]

Défini dans : Simplification/Simplification.ts:235

Chaque groupe de la dernière manche, y compris ceux ouverts, et ceux d'une règle ultérieure se sont repliés : le groupe qui en détient un répertorie également ses membres. summary().groups compte les groupes fermés dessinés par le canevas.

Renvoie ​

GroupInfo[]


getManualGroups() ​

getManualGroups(): ManualGroupRecord[]

Défini dans : Simplification/Simplification.ts:412

Les groupes faits à la main, pour qu'un hôte les sauve.

Renvoie ​

ManualGroupRecord[]


getRules() ​

getRules(): SimplifyRuleStatus[]

Défini dans : Simplification/Simplification.ts:158

Chaque règle, dans l'ordre d'exécution, avec ce qu'elle a fait lors de la dernière exécution.

Renvoie ​

SimplifyRuleStatus[]


groupableIds() ​

groupableIds(nodes): string[]

Défini dans : Simplification/Simplification.ts:441

Les nœuds réels qu'une sélection représente et qu'un groupe créé à la main peut détenir.

Paramètres ​

nodes ​

(string | Node)[]

Renvoie ​

string[]


groupLanding() ​

groupLanding(runId): void

Défini dans : Simplification/Simplification.ts:318

Obtenez ce que cette exécution pivot ajoute en groupes, un par type. Appelez-le avec graph.pivots.candidates(pivotId).runId avant pivots.ingest, pour que les nœuds ne soient jamais détachés ; en l'appelant après les avoir pliés lors du prochain redessinage. Ajoute la règle d'atterrissage Pivot en haut lorsqu'elle n'est pas déclarée et l'active.

Paramètres ​

runId ​

string

Renvoie ​

void


groupNodes() ​

groupNodes(nodes, title?): string | undefined

Défini dans : Simplification/Simplification.ts:360

Pliez ces nœuds en un seul groupe, intitulé title (non défini ou étiquette par défaut : étiqueté par ses types). Un groupe parmi eux donne ses membres. Un nœud déjà dans un groupe créé à la main le quitte ; les nœuds annotés et les clusters développés restent à l'écart. Renvoie l'identifiant du nouveau groupe, ou rien lorsque moins de deux nœuds peuvent être regroupés.

Paramètres ​

nodes ​

(string | Node)[]

title? ​

string

Renvoie ​

string | undefined


groupOf() ​

groupOf(node): GroupInfo | undefined

Défini dans : Simplification/Simplification.ts:240

Le groupe qui a placé la première règle à plier ce nœud l'a inséré.

Paramètres ​

node ​

string | Node

Renvoie ​

GroupInfo | undefined


isEnabled() ​

isEnabled(): boolean

Défini dans : Simplification/Simplification.ts:144

Si la fonctionnalité est activée (UI.simplify.enabled).

Renvoie ​

boolean


isLandingGrouped() ​

isLandingGrouped(runId): boolean

Défini dans : Simplification/Simplification.ts:348

Si cette course pivot a été demandée pour atterrir en groupe.

Paramètres ​

runId ​

string

Renvoie ​

boolean


isManual() ​

isManual(group): boolean

Défini dans : Simplification/Simplification.ts:406

Si ce groupe a été réalisé à la main.

Paramètres ​

group ​

GroupRef

Renvoie ​

boolean


isPulledOut() ​

isPulledOut(node): boolean

Défini dans : Simplification/Simplification.ts:308

Si un nœud a été retiré de son groupe.

Paramètres ​

node ​

string | Node

Renvoie ​

boolean


labelOf() ​

labelOf(info): string

Défini dans : Simplification/Simplification.ts:488

Le label d'un groupe : son titre, sinon ses parties jointes, la plus grande en premier.

Paramètres ​

info ​

GroupInfo

Renvoie ​

string


matchesIn() ​

matchesIn(group): number

Défini dans : Simplification/Simplification.ts:543

Combien de membres d'un groupe figurent parmi les matchs définis.

Paramètres ​

group ​

GroupInfo | GroupNode

Renvoie ​

number


onChange() ​

onChange(listener): () => void

Défini dans : Simplification/Simplification.ts:562

Abonnez-vous aux changements du regroupement. Renvoie son propre désabonnement.

Paramètres ​

listener ​

() => void

Renvoie ​

(): void

Renvoie ​

void


open() ​

open(group): void

Défini dans : Simplification/Simplification.ts:277

Remettez les membres d'un groupe sur la toile. Il reste ouvert jusqu'à sa fermeture ou sa dissolution.

Paramètres ​

group ​

GroupRef

Renvoie ​

void


pullOut() ​

pullOut(nodes): void

Défini dans : Simplification/Simplification.ts:290

Retirez les nœuds de leurs groupes pour la session ; chacun reste un nœud simple jusqu'à ce qu'il soit remis en place. Plusieurs à la fois se regroupent en même temps.

Paramètres ​

nodes ​

NodeRef | NodeRef[]

Renvoie ​

void


putBack() ​

putBack(nodes): void

Défini dans : Simplification/Simplification.ts:301

Laissez les nœuds retirés être à nouveau regroupés.

Paramètres ​

nodes ​

NodeRef | NodeRef[]

Renvoie ​

void


renameGroup() ​

renameGroup(group, title): void

Défini dans : Simplification/Simplification.ts:393

Renommer un groupe fait main ; un titre vide l'étiquette à nouveau par ses types.

Paramètres ​

group ​

GroupRef

title ​

string

Renvoie ​

void


ruleLabel() ​

ruleLabel(id): string

Défini dans : Simplification/Simplification.ts:501

Le nom qu'une règle porte sur sa carte, pour le sous-titre d'un groupe.

Paramètres ​

id ​

string

Renvoie ​

string


setManualGroups() ​

setManualGroups(records): void

Défini dans : Simplification/Simplification.ts:417

Remplacez les groupes créés à la main, comme le fait un hôte qui les restaure. Pas une étape d’annulation.

Paramètres ​

records ​

ManualGroupRecord[]

Renvoie ​

void


setMatches() ​

setMatches(nodes, query): void

Défini dans : Simplification/Simplification.ts:526

Marquer les correspondances d'une recherche : un groupe fermé en détenant tire sa part sur son anneau, et sa bulle d'aide les compte. Une liste vide les efface.

Paramètres ​

nodes ​

Node[]

query ​

string = ''

Renvoie ​

void


setRuleEnabled() ​

setRuleEnabled(id, enabled): void

Défini dans : Simplification/Simplification.ts:194

Activez ou désactivez une règle. La réactivation d’une règle ayant échoué réessaye.

Paramètres ​

id ​

string

enabled ​

boolean

Renvoie ​

void


setRuleMinSize() ​

setRuleMinSize(id, minSize): void

Défini dans : Simplification/Simplification.ts:203

Définissez le plus petit groupe d'une règle, limité à 2–50. Une règle avec un autre paramètre n'en a pas.

Paramètres ​

id ​

string

minSize ​

number

Renvoie ​

void


setRules() ​

setRules(rules): void

Défini dans : Simplification/Simplification.ts:149

Remplacez les règles. Leur ordre est l'ordre dans lequel ils courent.

Paramètres ​

rules ​

SimplifyRule[]

Renvoie ​

void


setRuleSetting() ​

setRuleSetting(id, value): void

Défini dans : Simplification/Simplification.ts:212

Définissez le paramètre d'une règle, ce que fait son stepper ou son curseur : le plus petit groupe (2 à 50), le moins de liens ou de force de base (1 à 10) ou le niveau des communautés (1 à 7).

Paramètres ​

id ​

string

value ​

number

Renvoie ​

void


summary() ​

summary(): object

Défini dans : Simplification/Simplification.ts:264

Ce que contient le canevas : total nœuds de niveau supérieur passent les filtres, folded d'entre eux siègent dans des groupes fermés et shown points sont dessinés pour eux, dont groups sont des groupes.

Renvoie ​

object

folded ​

folded: number

groups ​

groups: number

shown ​

shown: number

total ​

total: number


typeColor() ​

typeColor(info, type): string

Défini dans : Simplification/Simplification.ts:506

La couleur dans laquelle un membre de ce type est dessiné ; '' n'est pas un type.

Paramètres ​

info ​

GroupInfo

type ​

string

Renvoie ​

string


typeLabel() ​

typeLabel(type, count): string

Défini dans : Simplification/Simplification.ts:481

Le nom d'une partie d'un groupe, 12 × ip sauf si UI.simplify.typeLabel indique le contraire.

Paramètres ​

type ​

string | undefined

count ​

number

Renvoie ​

string


typesLabelOf() ​

typesLabelOf(info): string

Défini dans : Simplification/Simplification.ts:493

Les parties d'un groupe se rejoignent, les plus grandes en premier, quel que soit son titre.

Paramètres ​

info ​

Pick<GroupInfo, "typeCounts">

Renvoie ​

string


ungroup() ​

ungroup(groups): void

Défini dans : Simplification/Simplification.ts:379

Supprimez les groupes créés à la main, en une seule étape ; leurs membres sont dessinés comme ils le seraient sans eux.

Paramètres ​

groups ​

GroupRef | GroupRef[]

Renvoie ​

void


ungroupLanding() ​

ungroupLanding(runId): void

Défini dans : Simplification/Simplification.ts:343

Laissez ce que cette exécution a ajouté être à nouveau dessiné sous forme de nœuds simples.

Paramètres ​

runId ​

string

Renvoie ​

void