Aller au contenu

pivotick v3.0.0


pivotick / PivotickPlugin

Interface: PivotickPlugin ​

Défini dans : interfaces/Plugin.ts:31

Un plugin Pivotick : un ensemble autonome d'éléments d'interface utilisateur, de raccourcis clavier et de hooks de cycle de vie qui s'installe dans un graphique sans que le noyau ait besoin de savoir qu'il existe.

Enregistrez-en un soit de manière déclarative via GraphOptions.plugins, soit impérativement 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éthodes ​

install() ​

install(ctx): void

Défini dans : interfaces/Plugin.ts:35

Appelé une fois lorsque le plugin est installé.

Paramètres ​

ctx ​

PluginContext

Renvoie ​

void

Propriétés ​

name ​

name: string

Défini dans : interfaces/Plugin.ts:33

Identifiant stable, utilisé pour la journalisation et la déduplication.