Pular para o conteúdo

pivotick v3.0.0


pivotick / PivotickPlugin

Interface: PivotickPlugin ​

Definido em: interfaces/Plugin.ts:31

Um plugin Pivotick: um pacote independente de elementos de UI, atalhos de teclado e ganchos de ciclo de vida que se instala em um gráfico sem que o núcleo precise saber que ele existe.

Registre um declarativamente via GraphOptions.plugins ou imperativamente via Graph.use:

ts
const minimap: PivotickPlugin = {
    name: 'minimap',
    install(ctx) {
        ctx.addElement(new MinimapPanel(ctx.ui), ctx.layout?.canvas)
        ctx.addKeybinding({ key: 'm', callback: () => ... })
    },
}
new Graph(el, data, { plugins: [minimap] })
// or
graph.use(minimap)

Métodos ​

install() ​

install(ctx): void

Definido em: interfaces/Plugin.ts:35

Chamado uma vez quando o plugin é instalado.

Parâmetros ​

ctx ​

PluginContext

Retorno ​

void

Propriedades ​

name ​

name: string

Definido em: interfaces/Plugin.ts:33

Identificador estável, usado para registro e eliminação de duplicação.