Skip to main content
Version: Next

Interface: CustomSeriesHitTestResult

Result of a custom-series hit test.

Properties

distance

distance: number

Distance from the cursor to the hit geometry in CSS pixels.


objectId?

optional objectId: string

Optional identifier for the hovered custom object.


type?

optional type: "custom" | "line" | "point" | "range"

Geometric classification of the hit.

This is used by the library to compare the custom hit against other overlapping hits. It does not change the public hoveredInfo.type, which remains custom for custom-series hits. Use objectId (and hoveredInfo.objectKind) to identify specific custom objects.


cursorStyle?

optional cursorStyle: string

Optional cursor override.


hitTestData?

optional hitTestData: unknown

Optional renderer-specific data passed back into draw on hover.