charton API

---

charton API / @chart-on/ui / index / shellOf

Function: shellOf()

shellOf(ctx): ShellPluginHost | null

Defined in: ui/src/plugin-host.ts:34

The shell, as a plugin's install sees it: items it adds are removed when the plugin is uninstalled. Null when the chart has no shell.

install(ctx) {
  shellOf(ctx)?.addToolbarItem({ type: 'button', id: 'ruler', group: 'analysis', ... });
}

Parameters

ctx

PluginContext

Returns

ShellPluginHost | null