charton

Appearance

charton API

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

Interface: SeriesHoverEvent ​

Defined in: packages/core/src/chart.ts:1230

Payload of series:hover: the series under the pointer, if any, as the pointer moves over the plot.

Properties ​

item? ​

optional item?: PointItem

Defined in: packages/core/src/chart.ts:1234

On a point series: the item under the pointer (the nearest when markers overlap).

point ​

point: ChartPointerEvent | null

Defined in: packages/core/src/chart.ts:1236

Where the pointer is; null when no point is available (the pointer left, or the series was removed).

series ​

series: Series<object> | null

Defined in: packages/core/src/chart.ts:1232

Topmost visible candle, line, histogram or point series under the pointer, or null.