Skip to content

charton API


charton API / @chart-on/react / index / ChartInputs

Interface: ChartInputs ​

Defined in: sync.ts:8

The props both components hand to the engine.

Extended by ​

Properties ​

dataSource? ​

optional dataSource?: DataSource | null

Defined in: sync.ts:20

Where bars come from. Changing it attaches the new source and loads symbol again. The chart needs the dataSource() plugin in options.plugins (or builtins()); without it the source is not attached and development builds warn once (data-source-missing).


interval? ​

optional interval?: Interval

Defined in: sync.ts:23


options? ​

optional options?: ChartOptionsPatch

Defined in: sync.ts:14

Chart options. Given to the chart when it is created, then applied with applyOptions whenever they change. They are compared by value, so an object literal written inline does not apply again on every render.


symbol? ​

optional symbol?: string

Defined in: sync.ts:22

Symbol to load from dataSource; loads once both it and interval are set.