Interface CrosshairMoveEvent

Emitted on every crosshair move (and null fields on pointer-leave) so a host can render an OHLC legend / tooltip. bar is the hovered bar of the primary price series; point is container-relative media px for positioning a floating tooltip. See subscribeCrosshairMove.

interface CrosshairMoveEvent {
    bar: null | Bar;
    index: null | number;
    paneIndex?: null | number;
    point: null | { x: number; y: number };
    price: null | number;
    time: null | number;
}

Properties

bar: null | Bar

Hovered bar of the primary (first) price series, or null.

index: null | number

Logical index under the cursor, or null.

paneIndex?: null | number

Pane under the cursor, or null on leave.

point: null | { x: number; y: number }

Cursor position in container media px, or null on leave.

price: null | number

Price under the cursor on the hovered pane, or null.

time: null | number

UTC seconds of the hovered bar, or null when off the data / pointer left.