Skip to content

charton API


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

Interface: ChartFeatures ​

Defined in: packages/core/src/features.ts:6

Switches for built-in chart UI and input handling. Every flag can change at runtime through chart.applyOptions({ features }). They only gate user input and built-in drawing; API calls such as fitContent() still work.

Properties ​

attributionLogo: boolean

Defined in: packages/core/src/features.ts:44

A small project logo at the bottom of the plot on the start side, linking to the project site; screenshots show the mark and the site's name there. On by default; set it to false to hide it.


axisDragScale ​

axisDragScale: boolean

Defined in: packages/core/src/features.ts:20

Drag the price or time axis to rescale it; double-click an axis to reset it.


contextMenu ​

contextMenu: boolean

Defined in: packages/core/src/features.ts:14

Right click (and long press with touchInspect: 'off') emits chart:contextmenu and suppresses the browser menu while an app listens.


countdown ​

countdown: boolean

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

Time left in the current bar under the last price label. Needs lastValueLabels and the countdown() plugin.


keyboard ​

keyboard: boolean

Defined in: packages/core/src/features.ts:22

Keyboard shortcuts while the chart has focus, including the drawing shortcuts.


lastValueLabels ​

lastValueLabels: boolean

Defined in: packages/core/src/features.ts:12

Last-value labels on the price axis and the dotted last-price line.


legend ​

legend: boolean

Defined in: packages/core/src/features.ts:8

Series values in a corner of each pane (see the legend option).


legendButtons ​

legendButtons: boolean

Defined in: packages/core/src/features.ts:10

Show/hide, settings and remove buttons on each legend row, and a collapse toggle for long legends.


plusButton ​

plusButton: boolean

Defined in: packages/core/src/features.ts:32

The "+" button by the crosshair price label, shown while the app listens for plus:click.


scroll ​

scroll: boolean

Defined in: packages/core/src/features.ts:16

Pan by dragging the plot, horizontal wheel or trackpad scroll, momentum and arrow keys.


sketch ​

sketch: boolean

Defined in: packages/core/src/features.ts:38

Press and hold the plot still for half a second with a mouse or pen, then draw a stroke: on release it becomes the drawing it looks like most, see recognizeSketch. Off by default.


touchScroll ​

touchScroll: boolean

Defined in: packages/core/src/features.ts:24

One-finger drag pans on touch screens. Needs scroll.


touchZoom ​

touchZoom: boolean

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

Two-finger pinch zooms on touch screens. Needs zoom.


watermark ​

watermark: boolean

Defined in: packages/core/src/features.ts:30

The symbol and interval as a watermark behind the series (chart.watermark).


zoom ​

zoom: boolean

Defined in: packages/core/src/features.ts:18

Zoom with the mouse wheel, trackpad or touch pinch and the + / - keys.