Zum Inhalt springen

pivotick v3.0.0


Pivotick / PivotickPlugin

Interface: PivotickPlugin ​

Definiert in: interfaces/Plugin.ts:31

Ein Pivotick-Plugin: ein eigenständiges Paket aus UI-Elementen, Tastenkombinationen und Lebenszyklus-Hooks, das sich selbst in einem Diagramm installiert, ohne dass der Kern wissen muss, dass es existiert.

Registrieren Sie einen entweder deklarativ über GraphOptions.plugins oder zwingend über 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)

Methoden ​

install() ​

install(ctx): void

Definiert in: interfaces/Plugin.ts:35

Wird einmal aufgerufen, wenn das Plugin installiert ist.

Parameter ​

ctx ​

PluginContext

Rückgabewert ​

void

Eigenschaften ​

name ​

name: string

Definiert in: interfaces/Plugin.ts:33

Stabile Kennung, die für die Protokollierung und Deduplizierung verwendet wird.