charton API

---

charton API / @chart-on/core / index / ChartPlugin

Interface: ChartPlugin

Defined in: packages/core/src/plugins.ts:23

A bundle of extensions installed in one step with chart.install: drawing tools, indicators, custom series, primitives. Everything install adds through its context is removed again on uninstall.

Properties

name

name: string

Defined in: packages/core/src/plugins.ts:25

Unique per chart, e.g. the package name.

---

requires?

optional requires?: string

Defined in: packages/core/src/plugins.ts:28

Range of core versions it works with, e.g. '^0.1.0'; checked against CORE_VERSION.

---

version

version: string

Defined in: packages/core/src/plugins.ts:26

Methods

install()

install(ctx): void | (() => void)

Defined in: packages/core/src/plugins.ts:34

Add the plugin's contributions through ctx. May return a function that undoes anything else it set up; it runs on uninstall, before the contributions are removed.

Parameters

ctx

PluginContext

Returns

void | (() => void)