pivotick v3.0.0

---

pivotick / GraphUI / DockTab

Interface: DockTab

Défini dans : interfaces/GraphUI.ts:1365

Un volet dans le dock inférieur – une entrée dans sa bande d'onglets.

Le dock possède la region : la ligne de la grille, sa hauteur, le séparateur de redimensionnement et le pli. Un onglet possède ce qui est in : un corps et éventuellement ses propres contrôles d'en-tête, que le dock permute à mesure que l'onglet actif change. Avec un seul onglet enregistré, aucune bande n'est dessinée ; il n'y a rien à changer.

Enregistrez-en un à tout moment dans la vie du graphique avec graph.UIManager.addDockTab(), ou depuis le install d'un plugin via ctx.addDockTab(). Soit renvoie un broyeur.

Un onglet est un volet, pas une vue d'un seul. Un volet avec plusieurs vues qui lui sont propres - les Nodes et Edges de la table de données - est un unique qui dessine son propre commutateur dans son toolbar et appelle DockTabHandle.refresh pour changer de corps. Ainsi, la bande du dock répertorie les volets (Table, Events) et n'aplatit jamais les vues d'un volet à côté d'un autre volet ; les deux niveaux sont dessinés différemment pour la même raison.

La table de données est elle-même un tel onglet, donc un onglet enregistré est exactement aussi privilégié que l'onglet intégré.

Exemple

const dispose = graph.UIManager.addDockTab({
    label: 'Audit',
    render: () => myAuditPane(),
    toolbar: () => [clearButton],
})

Étendu par

• RegisteredDockTab

Propriétés

icon?

optional icon: string

Défini dans : interfaces/GraphUI.ts:1382

Glyphe dessiné avant l'étiquette dans la bande, marquant la provenance du panneau.

Une chaîne SVG, injectée de innerHTML et non aseptisée — il faut lui faire confiance, exactement comme PivotDefinition.icon. Utile lorsque plusieurs onglets sont du même type de volet : quatre avis de candidats et un tableau de données se lisent autrement comme une liste de cinq.

---

id?

optional id: string

Défini dans : interfaces/GraphUI.ts:1371

Identité stable : ce que prend le removeDockTab / activateDockTab et le data-tab écrit sur le bouton de la bande.

Valeur par défaut

un pvt-dock-tab-N généré automatiquement

---

label

label: string

Défini dans : interfaces/GraphUI.ts:1373

L'étiquette de la bande dessinée, utilisée textuellement (pour qu'elle puisse être traduite).

---

onActivate()?

optional onActivate: (tab) => void

Défini dans : interfaces/GraphUI.ts:1412

Appelé lorsque cet onglet apparaît au premier plan et lorsqu'il quitte. Un onglet qui surveille les données en direct devrait cesser de fonctionner en onDeactivate et rattraper son retard en onActivate : rien d'autre ne lui indique qu'il est hors écran.

Paramètres

tab

DockTabHandle

Renvoie

void

---

onDeactivate()?

optional onDeactivate: (tab) => void

Défini dans : interfaces/GraphUI.ts:1413

Paramètres

tab

DockTabHandle

Renvoie

void

---

order?

optional order: number

Défini dans : interfaces/GraphUI.ts:1406

Ordre d'affichage dans la bande, croissant. Des ordres égaux maintiennent l'ordre d'enregistrement - et comme les plugins s'installent après la construction de l'interface utilisateur, les onglets d'un plugin atterrissent après ceux intégrés sans avoir à le dire.

Valeur par défaut

0

---

render()

render: (tab) => HTMLElement

Défini dans : interfaces/GraphUI.ts:1388

Construisez le corps du volet. Appelé once, paresseusement, la première fois que l'onglet apparaît au premier plan - un onglet que personne n'ouvre ne coûte rien. L'élément est conservé et réattaché lors des activations ultérieures, il conserve donc son propre état (position de défilement incluse).

Paramètres

tab

DockTabHandle

Renvoie

HTMLElement

---

toolbar()?

optional toolbar: (tab) => HTMLElement | HTMLElement[]

Défini dans : interfaces/GraphUI.ts:1399

Créez les contrôles d'en-tête de cet onglet, disposés dans le cadre de la ligne d'en-tête du dock. Réinvoqué lors de l'activation chaque, afin que les contrôles puissent refléter l'état actuel de l'onglet.

Un volet avec plusieurs vues qui lui sont propres dessine ici le commutateur. Deux classes publiques lui donnent le même aspect que le tableau intégré - pvt-dock-views sur la bande, pvt-dock-view sur chaque bouton, active sur celui actuel - il reste donc un groupe de pilules à côté des propres onglets du dock et suit le thème.

Paramètres

tab

DockTabHandle

Renvoie

HTMLElement | HTMLElement[]