Pivotick / PluginContext
Interface: PluginContext
Definiert in: interfaces/Plugin.ts:43
Die an PivotickPlugin.install eines Plugins übergebenen Funktionen. Alles, was hier registriert wird, unterliegt demselben Lebenszyklus wie die integrierte Benutzeroberfläche und wird mit dieser abgebaut.
Methoden
addDockTab()
addDockTab(
tab): () =>void
Definiert in: interfaces/Plugin.ts:88
Registrieren Sie eine Scheibe im unteren Dock – die gleiche Tür wie UIManager.addDockTab und die, durch die der eingebaute Tisch kommt. Gibt einen Entsorger zurück.
Die erste Registerkarte erstellt die Region, sodass ein Plugin den Verbraucher nicht auffordern muss, das Dock einzuschalten: full-Modus ist die einzige Voraussetzung.
Parameter
tab
Rückgabewert
():
void
Rückgabewert
void
addElement()
addElement(
element,slot?):void
Definiert in: interfaces/Plugin.ts:70
Fügen Sie dem Lebenszyklus ein UI-Element hinzu. Wenn slot angegeben ist, wird das Element sofort darin montiert; es nimmt dann an jeder weiteren Phase teil (afterMount / graphReady / zerstören). Der Aufruf ist sicher, nachdem das Diagramm bereits live ist – das Element wird in der aktuellen Phase eingeholt.
Parameter
element
slot?
HTMLElement
Rückgabewert
void
addKeybinding()
addKeybinding(
binding):void
Definiert in: interfaces/Plugin.ts:132
Registrieren Sie eine Tastenkombination, die automatisch entfernt wird, wenn die Benutzeroberfläche abgeschaltet wird.
Parameter
binding
Rückgabewert
void
addPanel()
addPanel(
panel): () =>void
Definiert in: interfaces/Plugin.ts:76
Registrieren Sie ein Seitenleistenfeld – dieselbe Tür wie UI.extraPanels und UIManager.addPanel. Gibt einen Entsorger zurück; Das Panel wird bei jeder Auswahländerung neu gerendert und mit der Benutzeroberfläche abgebaut.
Parameter
panel
Rückgabewert
():
void
Rückgabewert
void
addPivot()
addPivot(
definition): () =>void
Definiert in: interfaces/Plugin.ts:128
Registrieren Sie einen Pivot – die gleiche Tür wie graph.pivots.register und die Option pivots und die Art und Weise, wie ein Plugin eine Anreicherung versendet. Gibt einen Entsorger zurück.
Der Pivot-Rail-Modus erscheint, sobald der erste Pivot registriert ist, und geht, wenn der letzte geht, sodass ein Plugin den Verbraucher nicht auffordern muss, etwas einzuschalten.
Parameter
definition
Rückgabewert
():
void
Rückgabewert
void
addRailMode()
addRailMode(
mode): () =>void
Definiert in: interfaces/Plugin.ts:110
Registrieren Sie einen Modus auf der Modusschiene – die gleiche Tür wie UIManager.addRailMode und die Art und Weise, wie ein Plugin seinen eigenen Explore- oder Enrich-Modus bereitstellt. Gibt einen Entsorger zurück.
Registrierte Modi werden unterhalb einer Trennlinie nach den vier integrierten Modi gerendert. Die Registrierung gelingt in jedem Modus; Die Schaltfläche wird nur dort gezeichnet, wo eine Schiene vorhanden ist (full und light).
Parameter
mode
Rückgabewert
():
void
Rückgabewert
void
addTopBarAction()
addTopBarAction(
action): () =>void
Definiert in: interfaces/Plugin.ts:117
Fügen Sie der oberen Leiste eine Pille hinzu – dieselbe Tür wie UIManager.addTopBarAction und UI.topBar.actions. Gibt einen Entsorger zurück. ui.refreshTopBar() liest seine Felder erneut.
Parameter
action
Rückgabewert
():
void
Rückgabewert
void
onPhase()
onPhase(
phase,callback): () =>void
Definiert in: interfaces/Plugin.ts:130
Binden Sie eine Lebenszyklusphase ein. Gibt eine Abmeldefunktion zurück.
Parameter
phase
callback
() => void
Rückgabewert
():
void
Rückgabewert
void
refreshDockTab()
refreshDockTab(
id):void
Definiert in: interfaces/Plugin.ts:96
Erstellen Sie eine Dock-Registerkarte aus render und toolbar neu – für den Fall, dass sich die eigenen Daten des Bereichs oder die ausgewählte Ansicht geändert haben. Das Gleiche macht ein refresh() von DockTabHandle für Code, der die ID und nicht das Handle enthält.
Parameter
id
string
Rückgabewert
void
refreshPanel()
refreshPanel(
id?):void
Definiert in: interfaces/Plugin.ts:80
Rendern Sie ein oder alle Seitenleistenfelder neu, wenn id weggelassen wird.
Parameter
id?
string
Rückgabewert
void
removeDockTab()
removeDockTab(
id):void
Definiert in: interfaces/Plugin.ts:90
Entfernen Sie eine Dock-Registerkarte anhand ihrer ID (entspricht dem Aufruf ihres Entsorgers).
Parameter
id
string
Rückgabewert
void
removePanel()
removePanel(
id):void
Definiert in: interfaces/Plugin.ts:78
Entfernen Sie ein Seitenleistenfeld anhand der ID (entspricht dem Aufruf seines Entsorgers).
Parameter
id
string
Rückgabewert
void
removeRailMode()
removeRailMode(
id):void
Definiert in: interfaces/Plugin.ts:112
Entfernen Sie einen Schienenmodus anhand der ID (entspricht dem Aufruf seines Entsorgers).
Parameter
id
string
Rückgabewert
void
removeTopBarAction()
removeTopBarAction(
id):void
Definiert in: interfaces/Plugin.ts:119
Entfernen Sie eine Aktion in der oberen Leiste anhand der ID (entspricht dem Aufruf ihres Entsorgers).
Parameter
id
string
Rückgabewert
void
setDockTabLabel()
setDockTabLabel(
id,label):void
Definiert in: interfaces/Plugin.ts:101
Benennen Sie eine Dock-Registerkarte im Strip um und lassen Sie dabei ihren Körper und ihre Bildlaufposition unverändert – eine Live-Zählung, ohne die Registerkarte erneut zu registrieren.
Parameter
id
string
label
string
Rückgabewert
void
Eigenschaften
graph
graph:
Pivotick
Definiert in: interfaces/Plugin.ts:44
i18n
i18n:
I18n
Definiert in: interfaces/Plugin.ts:63
Die Sprache des Diagramms: sein Gebietsschema, die Zahlen-, Listen- und Sortierformate und t über die eigenen Nachrichten der Bibliothek. Text, den das Plugin selbst schreibt, ist der zu übersetzende Text des Plugins, eingegeben auf i18n.locale.
keyManager
keyManager:
KeybindingManager
Definiert in: interfaces/Plugin.ts:57
layout
layout:
Layout|undefined
Definiert in: interfaces/Plugin.ts:56
Das Root-DOM-Gerüst, live von der Benutzeroberfläche gelesen (niemals ein veralteter Snapshot). Es existiert in jedem Modus, solange die Benutzeroberfläche aktiv ist, und ist erst undefined, nachdem die Benutzeroberfläche zerstört wurde. Seine Slots variieren je nach Modus: canvas und notification immer; graphnavigation in jedem Modus außer static; mainheader / modal / slidePanel / moderail / toolpanel / flyout / legend in full und light; sidebar nur in full.
canvas ist der Slot, den ein an der Arbeitsfläche angedocktes Element haben möchte – siehe Minimap-Plugin.
ui
ui:
UIManager
Definiert in: interfaces/Plugin.ts:45