draaipunt / PluginContext
Interface: PluginContext
Gedefinieerd in: interfaces/Plugin.ts:43
De mogelijkheden die aan PivotickPlugin.install van een plug-in worden gegeven. Wat dan ook hier geregistreerd wordt aangedreven door dezelfde levenscyclus als de ingebouwde gebruikersinterface en is gescheurd mee naar beneden.
Methoden
addDockTab()
addDockTab(
tab): () =>void
Gedefinieerd in: interfaces/Plugin.ts:88
Registreer een ruit in het onderste dock — dezelfde deur als UIManager.addDockTab, en degene waar de ingebouwde tafel doorheen komt. Retourneert een ontdoener.
Het eerste tabblad bouwt de regio, dus een plug-in hoeft de consument om het dock in te schakelen: full-modus is de enige vereiste.
Parameters
tab
Retouren
():
void
Retouren
void
addElement()
addElement(
element,slot?):void
Gedefinieerd in: interfaces/Plugin.ts:70
Voeg een UI-element toe aan de levenscyclus. Wanneer slot wordt opgegeven, is het element er onmiddellijk in gemonteerd; het neemt dan deel aan elke volgende fase (afterMount / graphReady / vernietigen). Veilig om na de grafiek te bellen is al live: het element is opgenomen in de huidige fase.
Parameters
element
slot?
HTMLElement
Retouren
void
addKeybinding()
addKeybinding(
binding):void
Gedefinieerd in: interfaces/Plugin.ts:132
Registreer een sneltoets die automatisch wordt verwijderd wanneer de gebruikersinterface wordt afgebroken.
Parameters
binding
Retouren
void
addPanel()
addPanel(
panel): () =>void
Gedefinieerd in: interfaces/Plugin.ts:76
Registreer een zijbalkpaneel — dezelfde deur als UI.extraPanels en UIManager.addPanel. Retourneert een ontdoener; het paneel wordt op elke pagina opnieuw weergegeven selectiewijziging en afgebroken met de gebruikersinterface.
Parameters
panel
Retouren
():
void
Retouren
void
addPivot()
addPivot(
definition): () =>void
Gedefinieerd in: interfaces/Plugin.ts:128
Registreer een draaipunt — dezelfde deur als graph.pivots.register en de pivots optie, en de manier waarop een plug-in een verrijking levert. Retourneert een ontdoener.
De Pivot rail-modus verschijnt zodra de eerste spil wordt geregistreerd en gaat als de laatste weggaat, hoeft een plug-in de consument dus niet te vragen om in te schakelen iets aan.
Parameters
definition
Retouren
():
void
Retouren
void
addRailMode()
addRailMode(
mode): () =>void
Gedefinieerd in: interfaces/Plugin.ts:110
Registreer een modus op de moderail — dezelfde deur als UIManager.addRailMode, en de manier waarop een plug-in zijn eigen Explore- of Enrich-modus verzendt. Retourneert een ontdoener.
Geregistreerde modi worden weergegeven onder een scheidingslijn, na de vier ingebouwde modi. Registratie slaagt in elke modus; de knop wordt alleen getekend waar er een rail is (full en light).
Parameters
mode
Retouren
():
void
Retouren
void
addTopBarAction()
addTopBarAction(
action): () =>void
Gedefinieerd in: interfaces/Plugin.ts:117
Voeg een pil toe aan de bovenste balk — dezelfde deur als UIManager.addTopBarAction en UI.topBar.actions. Retourneert een ontdoener. ui.refreshTopBar() leest de velden opnieuw.
Parameters
action
Retouren
():
void
Retouren
void
onPhase()
onPhase(
phase,callback): () =>void
Gedefinieerd in: interfaces/Plugin.ts:130
Sluit een levenscyclusfase aan. Retourneert een afmeldingsfunctie.
Parameters
phase
callback
() => void
Retouren
():
void
Retouren
void
refreshDockTab()
refreshDockTab(
id):void
Gedefinieerd in: interfaces/Plugin.ts:96
Bouw een docktabblad opnieuw op vanaf de render en toolbar — voor wanneer de eigen gegevens van het deelvenster of gekozen weergave gewijzigd. Hetzelfde als de refresh() van DockTabHandle doet, namelijk code die de id bevat in plaats van het handvat.
Parameters
id
string
Retouren
void
refreshPanel()
refreshPanel(
id?):void
Gedefinieerd in: interfaces/Plugin.ts:80
Geef één zijbalkpaneel opnieuw weer, of allemaal opnieuw als id wordt weggelaten.
Parameters
id?
string
Retouren
void
removeDockTab()
removeDockTab(
id):void
Gedefinieerd in: interfaces/Plugin.ts:90
Verwijder een docktabblad op basis van ID (gelijk aan het bellen van de ontdoener ervan).
Parameters
id
string
Retouren
void
removePanel()
removePanel(
id):void
Gedefinieerd in: interfaces/Plugin.ts:78
Verwijder een zijbalkpaneel op basis van ID (gelijk aan het aanroepen van de ontdoener ervan).
Parameters
id
string
Retouren
void
removeRailMode()
removeRailMode(
id):void
Gedefinieerd in: interfaces/Plugin.ts:112
Verwijder een railmodus op basis van ID (gelijk aan het aanroepen van de ontdoener ervan).
Parameters
id
string
Retouren
void
removeTopBarAction()
removeTopBarAction(
id):void
Gedefinieerd in: interfaces/Plugin.ts:119
Verwijder een actie in de bovenste balk op basis van ID (gelijk aan het aanroepen van de ontdoener ervan).
Parameters
id
string
Retouren
void
setDockTabLabel()
setDockTabLabel(
id,label):void
Gedefinieerd in: interfaces/Plugin.ts:101
Hernoem een docktabblad in de strip, waarbij de hoofdtekst en de schuifpositie met rust blijven: een live telling, zonder het tabblad opnieuw te registreren.
Parameters
id
string
label
string
Retouren
void
Eigenschappen
graph
graph:
Pivotick
Gedefinieerd in: interfaces/Plugin.ts:44
i18n
i18n:
I18n
Gedefinieerd in: interfaces/Plugin.ts:63
De taal van de grafiek: de landinstelling, het getal, de lijst- en sorteerformaten, en t over de eigen berichten van de bibliotheek. Tekst die de plug-in zelf schrijft, is die van de plug-in vertalen, ingetoetst op i18n.locale.
keyManager
keyManager:
KeybindingManager
Gedefinieerd in: interfaces/Plugin.ts:57
layout
layout:
Layout|undefined
Gedefinieerd in: interfaces/Plugin.ts:56
De root-DOM-scaffold, live gelezen vanuit de gebruikersinterface (nooit een verouderde momentopname). Het bestaat in elke modus terwijl de gebruikersinterface actief is en is pas daarna undefined de gebruikersinterface wordt vernietigd. De slots variëren per modus: canvas en notification altijd; graphnavigation in elke modus behalve static; mainheader / modal / slidePanel / moderail / toolpanel / flyout / legend in full en light; sidebar alleen in full.
canvas is het slot dat een canvas-gedockt element nodig heeft — zie de minimap-plug-in.
ui
ui:
UIManager
Gedefinieerd in: interfaces/Plugin.ts:45