charton

Appearance

charton API

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

Interface: LineInteractionOptions<L> ​

Defined in: packages/core/src/annotations/types.ts:146

Pointer callbacks and a tooltip for a line. Lines with none of them are not hit-tested unless they are draggable or have buttons, so they never block panning.

Extended by ​

Type Parameters ​

L ​

L

Properties ​

onClick? ​

optional onClick?: (e) => void

Defined in: packages/core/src/annotations/types.ts:152

Pressed and released on the line or its block without dragging it. Never after a drag.

Parameters ​

e ​

LinePointerEvent<L>

Returns ​

void

onHover? ​

optional onHover?: (e) => void

Defined in: packages/core/src/annotations/types.ts:148

The pointer moved onto the line or its label block. Once per enter.

Parameters ​

e ​

LinePointerEvent<L>

Returns ​

void

onHoverEnd? ​

optional onHoverEnd?: () => void

Defined in: packages/core/src/annotations/types.ts:150

The pointer left the line and its block. Once per leave.

Returns ​

void

tooltip? ​

optional tooltip?: string | string[]

Defined in: packages/core/src/annotations/types.ts:154

Text shown while hovering the line; several strings are several lines.