pivotick / PluginContext
Interface: PluginContext
Défini dans : interfaces/Plugin.ts:43
Les capacités transmises au PivotickPlugin.install d'un plugin. Tout ce qui est enregistré ici est piloté par le même cycle de vie que l'interface utilisateur intégrée et détruit avec elle.
Méthodes
addDockTab()
addDockTab(
tab): () =>void
Défini dans : interfaces/Plugin.ts:88
Enregistrez un volet dans le dock inférieur – la même porte que UIManager.addDockTab et celle par laquelle passe la table intégrée. Renvoie un broyeur.
Le premier onglet construit la région, donc un plugin n'a pas besoin de demander au consommateur d'allumer le dock : le mode full est la seule exigence.
Paramètres
tab
Renvoie
():
void
Renvoie
void
addElement()
addElement(
element,slot?):void
Défini dans : interfaces/Plugin.ts:70
Ajoutez un élément d'interface utilisateur dans le cycle de vie. Lorsque slot est donné, l'élément y est immédiatement monté ; il participe ensuite à chaque phase ultérieure (afterMount / graphReady / détruire). Appel sécurisé une fois que le graphique est déjà actif : l'élément est rattrapé par la phase actuelle.
Paramètres
element
slot?
HTMLElement
Renvoie
void
addKeybinding()
addKeybinding(
binding):void
Défini dans : interfaces/Plugin.ts:132
Enregistrez une combinaison de touches qui est automatiquement supprimée lorsque l'interface utilisateur est supprimée.
Paramètres
binding
Renvoie
void
addPanel()
addPanel(
panel): () =>void
Défini dans : interfaces/Plugin.ts:76
Enregistrez un panneau de barre latérale – la même porte que UI.extraPanels et UIManager.addPanel. Renvoie un broyeur ; le panneau est restitué à chaque changement de sélection et démoli avec l'interface utilisateur.
Paramètres
panel
Renvoie
():
void
Renvoie
void
addPivot()
addPivot(
definition): () =>void
Défini dans : interfaces/Plugin.ts:128
Enregistrez un pivot — la même porte que l'option graph.pivots.register et l'option pivots, et la manière dont un plugin fournit un enrichissement. Renvoie un broyeur.
Le mode rail Pivot apparaît dès que le premier pivot est enregistré et disparaît lorsque le dernier part, donc un plugin n'a pas besoin de demander au consommateur d'allumer quoi que ce soit.
Paramètres
definition
Renvoie
():
void
Renvoie
void
addRailMode()
addRailMode(
mode): () =>void
Défini dans : interfaces/Plugin.ts:110
Enregistrez un mode sur le rail de mode – la même porte que UIManager.addRailMode et la façon dont un plugin propose son propre mode Explorer ou Enrich. Renvoie un broyeur.
Les modes enregistrés s'affichent sous un diviseur, après les quatre modes intégrés. L'inscription réussit dans tous les modes ; le bouton n'est dessiné que là où il y a un rail (full et light).
Paramètres
mode
Renvoie
():
void
Renvoie
void
addTopBarAction()
addTopBarAction(
action): () =>void
Défini dans : interfaces/Plugin.ts:117
Ajoutez une pilule à la barre supérieure – la même porte que UIManager.addTopBarAction et UI.topBar.actions. Renvoie un broyeur. ui.refreshTopBar() relit ses champs.
Paramètres
action
Renvoie
():
void
Renvoie
void
onPhase()
onPhase(
phase,callback): () =>void
Défini dans : interfaces/Plugin.ts:130
Accrochez une phase du cycle de vie. Renvoie une fonction de désabonnement.
Paramètres
phase
callback
() => void
Renvoie
():
void
Renvoie
void
refreshDockTab()
refreshDockTab(
id):void
Défini dans : interfaces/Plugin.ts:96
Reconstruisez un onglet de dock à partir de ses render et toolbar — lorsque les propres données du volet ou la vue choisie ont changé. La même chose que le refresh() d'un DockTabHandle, pour le code qui contient l'identifiant plutôt que le handle.
Paramètres
id
string
Renvoie
void
refreshPanel()
refreshPanel(
id?):void
Défini dans : interfaces/Plugin.ts:80
Restituez un panneau de la barre latérale, ou tous les panneaux lorsque id est omis.
Paramètres
id?
string
Renvoie
void
removeDockTab()
removeDockTab(
id):void
Défini dans : interfaces/Plugin.ts:90
Supprimez un onglet de dock par identifiant (équivalent à appeler son broyeur).
Paramètres
id
string
Renvoie
void
removePanel()
removePanel(
id):void
Défini dans : interfaces/Plugin.ts:78
Supprimez un panneau de barre latérale par identifiant (équivalent à appeler son broyeur).
Paramètres
id
string
Renvoie
void
removeRailMode()
removeRailMode(
id):void
Défini dans : interfaces/Plugin.ts:112
Supprimez un mode ferroviaire par identifiant (équivalent à appeler son broyeur).
Paramètres
id
string
Renvoie
void
removeTopBarAction()
removeTopBarAction(
id):void
Défini dans : interfaces/Plugin.ts:119
Supprimez une action de la barre supérieure par identifiant (équivalent à appeler son broyeur).
Paramètres
id
string
Renvoie
void
setDockTabLabel()
setDockTabLabel(
id,label):void
Défini dans : interfaces/Plugin.ts:101
Renommez un onglet de dock dans la bande, en laissant son corps et sa position de défilement seuls - un décompte en direct, sans réenregistrer l'onglet.
Paramètres
id
string
label
string
Renvoie
void
Propriétés
graph
graph:
Pivotick
Défini dans : interfaces/Plugin.ts:44
i18n
i18n:
I18n
Défini dans : interfaces/Plugin.ts:63
La langue du graphique : ses paramètres régionaux, les formats de nombre, de liste et de tri, et t sur les propres messages de la bibliothèque. Le texte que le plugin écrit lui-même est celui du plugin à traduire, saisi sur i18n.locale.
keyManager
keyManager:
KeybindingManager
Défini dans : interfaces/Plugin.ts:57
layout
layout:
Layout|undefined
Défini dans : interfaces/Plugin.ts:56
L'échafaudage DOM racine, lu en direct depuis l'interface utilisateur (jamais un instantané obsolète). Il existe dans tous les modes tant que l'interface utilisateur est active et est undefined seulement après la destruction de l'interface utilisateur. Ses emplacements varient selon le mode : canvas et notification toujours ; graphnavigation dans tous les modes sauf static ; mainheader / modal / slidePanel / moderail / toolpanel / flyout / legend en full et light ; sidebar en full uniquement.
canvas est l'emplacement souhaité par un élément ancré dans le canevas — voir le plugin minimap.
ui
ui:
UIManager
Défini dans : interfaces/Plugin.ts:45