useChartHandle

Documentation / @elitechart/elitechart / useChartHandle

code

function useChartHandle(): ChartHandle | null;

Defined in: elitechart/src/lib/chart/handleRef.ts:58

React hook — returns the current chart handle, or null before mount. Components should guard with if (handle === null) return; on both render AND effect paths.

Returns

ChartHandle | null

Example

code

import { useEffect } from 'react';
import { useChartHandle } from '@elitechart/elitechart';

function CrosshairLogger() {
  const chart = useChartHandle();
  useEffect(() => {
    if (chart === null) return;
    const off = chart.on('crosshair:move', (p) => console.log(p));
    return off;
  }, [chart]);
  return null;
}