G-code Preview — API Reference
    Preparing search index...

    Interface GcodePreviewHandle

    interface GcodePreviewHandle {
        canvasRef: (el: null | HTMLCanvasElement) => void;
        controls: GcodePreviewControls;
        raw: { renderer: () => null | PreviewRenderer; session: GcodeParseSession };
        state: GcodePreviewState;
        cancel(): void;
        capture(opts?: CaptureOptions): Promise<Blob>;
        clearProgress(): void;
        dispose(): void;
        observeProgress(obs: ProgressObservation): null | MappedProgress;
        onEvent(cb: (e: PreviewEvent) => void): () => void;
        parse(
            input: ArrayBuffer | Uint8Array<ArrayBufferLike> | File,
            opts?: WireParseOptions,
        ): Promise<ParseOutcome>;
        tickProgress(nowMs: number): null | MappedProgress;
    }
    Index

    Properties

    canvasRef controls raw state

    Methods

    cancel capture clearProgress dispose observeProgress onEvent parse tickProgress

    Properties

    canvasRef: (el: null | HTMLCanvasElement) => void

    Attach as <canvas ref={preview.canvasRef} />; null detaches safely.

    controls: GcodePreviewControls
    raw: { renderer: () => null | PreviewRenderer; session: GcodeParseSession }
    state: GcodePreviewState

    Current state snapshot — render-subscribed via useSyncExternalStore.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods