Interface: Plugin

Vizzu plugin interface.

Properties

api?

optional api: PluginApi

Any parameter or method the Plugin exposes for the user.

enable()?

optional enable: (enabled) => void

Method called by Vizzu indicating for the plugin that it got switched on/off. If switched off, its event listeners gets removed and its hooks won't be called.

Parameters

enabled

boolean

Returns

void

hooks?

optional hooks: PluginHooks\<Hooks>

Hooks the plugin implemenst. They work only if the plugin is enabled.

listeners?

optional listeners: PluginListeners

Event listeners the plugin implements. They work only if the plugin is enabled.

meta?

optional meta: PluginMeta

Metainfo about the plugin.

register()?

optional register: (ctx) => void

Register called when the plugin added to vizzu, receiving the Vizzu instance.

Parameters

ctx

vizzu

Returns

void

unregister()?

optional unregister: (ctx) => void

Unregister is called when detach() called on the Vizzu instance.

Parameters

ctx

vizzu

Returns

void