charton

Appearance

charton API

charton API / @chart-on/vue / shell / ChartShellProps

Interface: ChartShellProps ​

Defined in: shell.ts:51

The props of <ChartShell>, for apps that build them in code.

Extends ​

Properties ​

dataSource? ​

optional dataSource?: DataSource | null

Defined in: sync.ts:28

Where bars come from. Changing it attaches the new source and loads symbol again; null detaches it. Like every prop, leaving it out or setting it to undefined leaves the chart as it is. 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).

Inherited from ​

ChartInputs.dataSource

features? ​

optional features?: Partial<ShellFeatures>

Defined in: shell.ts:54

interval? ​

optional interval?: Interval

Defined in: sync.ts:31

Inherited from ​

ChartInputs.interval

on? ​

optional on?: ChartEventHandlers

Defined in: shell.ts:56

options? ​

optional options?: ChartOptionsPatch

Defined in: sync.ts:19

Chart options. Given to the chart when it is created, then applied with applyOptions whenever they change, including changes made inside a reactive object. Plain data in them is compared by value, so an object literal written in the template does not apply again on every render. Functions, dates and class instances are compared by identity: a formatter written inline in the template is new on every render and applies the options again each time, so define callbacks once in the script.

Inherited from ​

ChartInputs.options

palette? ​

optional palette?: ShellPalette

Defined in: shell.ts:53

shellOn? ​

optional shellOn?: ShellEventHandlers

Defined in: shell.ts:57

shellOptions? ​

optional shellOptions?: ShellCreationOptions

Defined in: shell.ts:55

symbol? ​

optional symbol?: string

Defined in: sync.ts:30

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

Inherited from ​

ChartInputs.symbol

theme? ​

optional theme?: ShellTheme

Defined in: shell.ts:52