Skip to content

charton API


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

Function: pickBar() ​

pickBar(chart): Promise<PickedBar | null>

Defined in: packages/core/src/pick-bar.ts:23

Let the user pick a bar: the next click on a bar of the main series resolves with it, showing a crosshair cursor meanwhile. Escape, another pickBar, cancelPickBar or destroying the chart resolve with null. Clicks beyond the bars are ignored.

Parameters ​

chart ​

Chart

Returns ​

Promise<PickedBar | null>