Interface UseCharturboChartResult

interface UseCharturboChartResult {
    canvasRef: RefObject<HTMLCanvasElement | null>;
    error: unknown;
    sdk: Charturbo | null;
    getSdk(): Charturbo | null;
    whenReady(): Promise<Charturbo | null>;
}

Index

Properties

canvasRef error sdk

Methods

getSdk whenReady

Properties

canvasRef

canvasRef: RefObject<HTMLCanvasElement | null>

error

error: unknown

Last create / render error (CharturboInitError without WebGPU / WebGL2)

sdk

sdk: Charturbo | null

The engine once ready (null before and after unmount); changing it re-renders

Methods

getSdk

getSdk(): Charturbo | null
Live engine (no re-render needed; e.g. inside onReady or after whenReady)

Returns Charturbo | null
- Defined in react/useCharturboChart.ts:53

whenReady

whenReady(): Promise<Charturbo | null>
Resolves with the engine, or null when unmounted first / create failed (also null when called before the mount effect ran, e.g. from a parent's layout effect)

Returns Promise<Charturbo | null>
- Defined in react/useCharturboChart.ts:58