pivotick / PluginContext
Interface: PluginContext
Definido em: interfaces/Plugin.ts:43
Os recursos entregues ao PivotickPlugin.install de um plugin. Qualquer coisa registrada aqui é conduzida pelo mesmo ciclo de vida da UI integrada e desmontada com ela.
Métodos
addDockTab()
addDockTab(
tab): () =>void
Definido em: interfaces/Plugin.ts:88
Registre um painel no encaixe inferior - a mesma porta de UIManager.addDockTab e aquela por onde passa a mesa embutida. Retorna um triturador.
A primeira aba constrói a região, então um plugin não precisa pedir ao consumidor para ligar o dock: o modo full é o único requisito.
Parâmetros
tab
Retorno
():
void
Retorno
void
addElement()
addElement(
element,slot?):void
Definido em: interfaces/Plugin.ts:70
Adicione um elemento de UI ao ciclo de vida. Quando slot é fornecido, o elemento é montado nele imediatamente; ele então participa de todas as fases subsequentes (afterMount / graphReady / destruir). É seguro chamar depois que o gráfico já estiver ativo - o elemento está atualizado para a fase atual.
Parâmetros
element
slot?
HTMLElement
Retorno
void
addKeybinding()
addKeybinding(
binding):void
Definido em: interfaces/Plugin.ts:132
Registre um atalho de teclado que é removido automaticamente quando a IU é desmontada.
Parâmetros
binding
Retorno
void
addPanel()
addPanel(
panel): () =>void
Definido em: interfaces/Plugin.ts:76
Registre um painel da barra lateral — a mesma porta de UI.extraPanels e UIManager.addPanel. Retorna um triturador; o painel é renderizado novamente a cada alteração de seleção e desmontado com a interface do usuário.
Parâmetros
panel
Retorno
():
void
Retorno
void
addPivot()
addPivot(
definition): () =>void
Definido em: interfaces/Plugin.ts:128
Registre um pivô — a mesma porta que graph.pivots.register e a opção pivots, e a forma como um plugin envia um enriquecimento. Retorna um triturador.
O modo Pivot rail aparece assim que o primeiro pivô é cadastrado e desaparece quando o último sai, assim um plugin não precisa pedir ao consumidor para ligar nada.
Parâmetros
definition
Retorno
():
void
Retorno
void
addRailMode()
addRailMode(
mode): () =>void
Definido em: interfaces/Plugin.ts:110
Registre um modo no modo rail - a mesma porta que UIManager.addRailMode, e a forma como um plugin envia seu próprio modo Explorar ou Enriquecer. Retorna um triturador.
Os modos registrados são renderizados abaixo de um divisor, após os quatro modos integrados. O registro é bem-sucedido em todos os modos; o botão só é desenhado onde há um trilho (full e light).
Parâmetros
mode
Retorno
():
void
Retorno
void
addTopBarAction()
addTopBarAction(
action): () =>void
Definido em: interfaces/Plugin.ts:117
Adicione uma pílula à barra superior – a mesma porta de UIManager.addTopBarAction e UI.topBar.actions. Retorna um triturador. ui.refreshTopBar() relê seus campos.
Parâmetros
action
Retorno
():
void
Retorno
void
onPhase()
onPhase(
phase,callback): () =>void
Definido em: interfaces/Plugin.ts:130
Conecte uma fase do ciclo de vida. Retorna uma função de cancelamento de assinatura.
Parâmetros
phase
callback
() => void
Retorno
():
void
Retorno
void
refreshDockTab()
refreshDockTab(
id):void
Definido em: interfaces/Plugin.ts:96
Reconstrua uma guia de encaixe a partir de render e toolbar — para quando os próprios dados do painel ou a visualização escolhida forem alterados. A mesma coisa que um refresh() de DockTabHandle faz, para código que contém o id em vez do identificador.
Parâmetros
id
string
Retorno
void
refreshPanel()
refreshPanel(
id?):void
Definido em: interfaces/Plugin.ts:80
Rerenderize um painel da barra lateral, ou todos eles quando id for omitido.
Parâmetros
id?
string
Retorno
void
removeDockTab()
removeDockTab(
id):void
Definido em: interfaces/Plugin.ts:90
Remova uma guia de encaixe por id (equivalente a chamar seu triturador).
Parâmetros
id
string
Retorno
void
removePanel()
removePanel(
id):void
Definido em: interfaces/Plugin.ts:78
Remova um painel da barra lateral por id (equivalente a chamar seu triturador).
Parâmetros
id
string
Retorno
void
removeRailMode()
removeRailMode(
id):void
Definido em: interfaces/Plugin.ts:112
Remova um modo ferroviário por id (equivalente a chamar seu triturador).
Parâmetros
id
string
Retorno
void
removeTopBarAction()
removeTopBarAction(
id):void
Definido em: interfaces/Plugin.ts:119
Remova uma ação da barra superior por id (equivalente a chamar seu triturador).
Parâmetros
id
string
Retorno
void
setDockTabLabel()
setDockTabLabel(
id,label):void
Definido em: interfaces/Plugin.ts:101
Renomeie uma guia de encaixe na faixa, deixando seu corpo e sua posição de rolagem sozinhos - uma contagem ao vivo, sem registrar novamente a guia.
Parâmetros
id
string
label
string
Retorno
void
Propriedades
graph
graph:
Pivotick
Definido em: interfaces/Plugin.ts:44
i18n
i18n:
I18n
Definido em: interfaces/Plugin.ts:63
O idioma do gráfico: sua localidade, o número, a lista e os formatos de classificação e t sobre as próprias mensagens da biblioteca. O texto que o plugin escreve é o do plugin a ser traduzido, digitado em i18n.locale.
keyManager
keyManager:
KeybindingManager
Definido em: interfaces/Plugin.ts:57
layout
layout:
Layout|undefined
Definido em: interfaces/Plugin.ts:56
O andaime raiz do DOM, lido ao vivo na interface do usuário (nunca um instantâneo obsoleto). Ele existe em todos os modos enquanto a UI está ativa e é undefined somente depois que a UI é destruída. Seus slots são os que variam de acordo com o modo: canvas e notification sempre; graphnavigation em todos os modos, exceto static; mainheader / modal / slidePanel / moderail / toolpanel / flyout / legend em full e light; sidebar em full apenas.
canvas é o slot que um elemento encaixado na tela deseja — veja o plugin do minimapa.
ui
ui:
UIManager
Definido em: interfaces/Plugin.ts:45