Skip to content

charton API


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

Function: createPointerTooltip() ​

createPointerTooltip(chart, options?): PointerTooltipHandle

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

Small box beside the pointer with the values of the bar under the crosshair, for embeds that turn the legend off. It sits beside the bar, so it never covers it, and stays inside the plot. On touch it shows only while a long-press inspects (see the chart's touchInspect option) or the crosshair is locked, so a plain pan does not flash it. The legend and the data window carry the same values for assistive technology, so it is hidden from it. Requires @chart-on/ui/style.css (--pc-tip-* tokens).

Parameters ​

chart ​

Chart

options? ​

PointerTooltipOptions = {}

Returns ​

PointerTooltipHandle