pivotic / PluginContext
Interfaz: PluginContext
Definido en: interfaces/Plugin.ts:43
Las capacidades entregadas al PivotickPlugin.install de un complemento. cualquier cosa registrado aquí está impulsado por el mismo ciclo de vida que la interfaz de usuario incorporada y desgarrado abajo con eso.
Métodos
addDockTab()
addDockTab(
tab): () =>void
Definido en: interfaces/Plugin.ts:88
Registre un panel en el muelle inferior: la misma puerta que UIManager.addDockTab, y por el que pasa la mesa empotrada. Devuelve un triturador.
La primera pestaña crea la región, por lo que un complemento no tiene que preguntarle al consumidor encienda la base: el modo full es el único requisito.
Parámetros
tab
Devoluciones
():
void
Devoluciones
void
addElement()
addElement(
element,slot?):void
Definido en: interfaces/Plugin.ts:70
Agregue un elemento de interfaz de usuario al ciclo de vida. Cuando se da slot el elemento es montado en él inmediatamente; luego participa en cada subsiguiente fase (afterMount / graphReady / destruir). Es seguro llamar después del gráfico ya está activo: el elemento está al día con la fase actual.
Parámetros
element
slot?
HTMLElement
Devoluciones
void
addKeybinding()
addKeybinding(
binding):void
Definido en: interfaces/Plugin.ts:132
Registre una combinación de teclas que se elimina automáticamente cuando se elimina la interfaz de usuario.
Parámetros
binding
Devoluciones
void
addPanel()
addPanel(
panel): () =>void
Definido en: interfaces/Plugin.ts:76
Registre un panel de barra lateral: la misma puerta que UI.extraPanels y UIManager.addPanel. Devuelve un triturador; el panel se vuelve a renderizar en cada cambio de selección y derribado con la interfaz de usuario.
Parámetros
panel
Devoluciones
():
void
Devoluciones
void
addPivot()
addPivot(
definition): () =>void
Definido en: interfaces/Plugin.ts:128
Registre un pivote: la misma puerta que graph.pivots.register y pivots opción y la forma en que un complemento envía un enriquecimiento. Devuelve un triturador.
El modo de carril de pivote aparece tan pronto como se registra el primer pivote y pasa cuando el último se va, por lo que un complemento no tiene que pedirle al consumidor que gire cualquier cosa.
Parámetros
definition
Devoluciones
():
void
Devoluciones
void
addRailMode()
addRailMode(
mode): () =>void
Definido en: interfaces/Plugin.ts:110
Registre un modo en el carril de modo: la misma puerta que UIManager.addRailMode, y la forma en que un complemento incluye su propio modo Explorar o Enriquecer. Devuelve un triturador.
Los modos registrados se muestran debajo de un divisor, después de los cuatro modos integrados. Registro tiene éxito en todos los modos; el botón solo se dibuja donde hay un riel (full y light).
Parámetros
mode
Devoluciones
():
void
Devoluciones
void
addTopBarAction()
addTopBarAction(
action): () =>void
Definido en: interfaces/Plugin.ts:117
Agregue una pastilla a la barra superior: la misma puerta que UIManager.addTopBarAction y UI.topBar.actions. Devuelve un triturador. ui.refreshTopBar() vuelve a leer sus campos.
Parámetros
action
Devoluciones
():
void
Devoluciones
void
onPhase()
onPhase(
phase,callback): () =>void
Definido en: interfaces/Plugin.ts:130
Enganche una fase del ciclo de vida. Devuelve una función para cancelar la suscripción.
Parámetros
phase
callback
() => void
Devoluciones
():
void
Devoluciones
void
refreshDockTab()
refreshDockTab(
id):void
Definido en: interfaces/Plugin.ts:96
Reconstruya una pestaña del acoplamiento a partir de su render y toolbar, para cuando los datos del propio panel o la vista elegida cambió. Lo mismo que hace un DockTabHandle refresh(), por código que contiene la identificación en lugar del identificador.
Parámetros
id
string
Devoluciones
void
refreshPanel()
refreshPanel(
id?):void
Definido en: interfaces/Plugin.ts:80
Vuelva a renderizar un panel de la barra lateral, o todos ellos cuando se omite id.
Parámetros
id?
string
Devoluciones
void
removeDockTab()
removeDockTab(
id):void
Definido en: interfaces/Plugin.ts:90
Elimine una pestaña del muelle por identificación (equivalente a llamar a su eliminador).
Parámetros
id
string
Devoluciones
void
removePanel()
removePanel(
id):void
Definido en: interfaces/Plugin.ts:78
Elimine un panel de la barra lateral por identificación (equivalente a llamar a su eliminador).
Parámetros
id
string
Devoluciones
void
removeRailMode()
removeRailMode(
id):void
Definido en: interfaces/Plugin.ts:112
Eliminar un modo ferroviario por identificación (equivalente a llamar a su eliminador).
Parámetros
id
string
Devoluciones
void
removeTopBarAction()
removeTopBarAction(
id):void
Definido en: interfaces/Plugin.ts:119
Eliminar una acción de la barra superior por identificación (equivalente a llamar a su eliminador).
Parámetros
id
string
Devoluciones
void
setDockTabLabel()
setDockTabLabel(
id,label):void
Definido en: interfaces/Plugin.ts:101
Cambie el nombre de una pestaña acoplable en la tira, dejando solo su cuerpo y su posición de desplazamiento: un conteo en vivo, sin volver a registrar la pestaña.
Parámetros
id
string
label
string
Devoluciones
void
Propiedades
graph
graph:
Pivotick
Definido en: interfaces/Plugin.ts:44
i18n
i18n:
I18n
Definido en: interfaces/Plugin.ts:63
El idioma del gráfico: su ubicación, los formatos de número, lista y clasificación, y t sobre los propios mensajes de la biblioteca. El texto que el complemento escribe es el del complemento. traducir, tecleando i18n.locale.
keyManager
keyManager:
KeybindingManager
Definido en: interfaces/Plugin.ts:57
layout
layout:
Layout|undefined
Definido en: interfaces/Plugin.ts:56
El andamio DOM raíz, leído en vivo desde la interfaz de usuario (nunca una instantánea obsoleta). eso existe en todos los modos mientras la interfaz de usuario está activa y es undefined solo después la interfaz de usuario está destruida. Sus slots son los que varían según el modo: canvas y notification siempre; graphnavigation en todos los modos excepto static; mainheader / modal / slidePanel / moderail / toolpanel / flyout / legend en full y light; sidebar en full únicamente.
canvas es la ranura que desea un elemento acoplado al lienzo; consulte el complemento de minimapa.
ui
ui:
UIManager
Definido en: interfaces/Plugin.ts:45