charton

Appearance

charton API

charton API / @chart-on/ui / index / PointerTooltipOptions

Interface: PointerTooltipOptions ​

Defined in: ui/src/pointer-tooltip.ts:6

Options for createPointerTooltip: its content, how long to wait before showing, and whether it follows the crosshair or sits at the top.

Properties ​

anchor? ​

optional anchor?: "top" | "pointer"

Defined in: ui/src/pointer-tooltip.ts:16

pointer sits level with the crosshair; top pins it to the top of the plot. Default pointer.

delay? ​

optional delay?: number

Defined in: ui/src/pointer-tooltip.ts:14

Wait this long (ms) after the crosshair appears before showing. Default 0.

format? ​

optional format?: (values) => string | Node | null

Defined in: ui/src/pointer-tooltip.ts:12

Content for the bar under the crosshair: text, an element, or null to show nothing there. Default: the time, then each visible series' values as the legend formats them.

Parameters ​

values ​

ValuesAt

Returns ​

string | Node | null