@kanaries/graphic-walker 0.3.11 → 0.3.13

package/dist/interfaces.d.ts

@@ -1,4 +1,4 @@
-import { Config as VgConfig } from 'vega';
+import { Config as VgConfig, View } from 'vega';
 import { Config as VlConfig } from 'vega-lite';
 export type DeepReadonly<T extends Record<keyof any, any>> = {
     readonly [K in keyof T]: T[K] extends Record<keyof any, any> ? DeepReadonly<T[K]> : T[K];
@@ -191,6 +191,16 @@ export declare enum ISegmentKey {
 export type IThemeKey = 'vega' | 'g2';
 export type IDarkMode = 'media' | 'light' | 'dark';
 export type VegaGlobalConfig = VgConfig | VlConfig;
+export interface IVegaChartRef {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    innerWidth: number;
+    innerHeight: number;
+    view: View;
+    canvas: HTMLCanvasElement | null;
+}
 export interface IChartExportResult<T extends 'svg' | 'data-url' = 'svg' | 'data-url'> {
     mode: T;
     title: string;
@@ -201,14 +211,81 @@ export interface IChartExportResult<T extends 'svg' | 'data-url' = 'svg' | 'data
         rowIndex: number;
         width: number;
         height: number;
+        canvasWidth: number;
+        canvasHeight: number;
         data: string;
+        canvas(): HTMLCanvasElement | null;
     }[];
+    container(): HTMLDivElement | null;
 }
 interface IExportChart {
     <T extends Extract<IChartExportResult['mode'], 'svg'>>(mode?: T): Promise<IChartExportResult<T>>;
     <T extends IChartExportResult['mode']>(mode: T): Promise<IChartExportResult<T>>;
 }
+export interface IChartListExportResult<T extends 'svg' | 'data-url' = 'svg' | 'data-url'> {
+    mode: T;
+    total: number;
+    index: number;
+    data: IChartExportResult<T>;
+    hasNext: boolean;
+}
+interface IExportChartList {
+    <T extends Extract<IChartExportResult['mode'], 'svg'>>(mode?: T): AsyncGenerator<IChartListExportResult<T>, void, unknown>;
+    <T extends IChartExportResult['mode']>(mode: T): AsyncGenerator<IChartListExportResult<T>, void, unknown>;
+}
+/**
+ * The status of the current chart.
+ * * `computing`: _GraphicWalker_ is computing the data view.
+ * * `rendering`: _GraphicWalker_ is rendering the chart.
+ * * `idle`: rendering is finished.
+ * * `error`: an error occurs during the process above.
+ */
+export type IRenderStatus = 'computing' | 'rendering' | 'idle' | 'error';
 export interface IGWHandler {
+    /** length of the "chart" tab list */
+    chartCount: number;
+    /** current selected chart index */
+    chartIndex: number;
+    /** Switches to the specified chart */
+    openChart: (index: number) => void;
+    /**
+     * Returns the status of the current chart.
+     *
+     * It is computed by the following rules:
+     * - If _GraphicWalker_ is computing the data view, it returns `computing`.
+     * - If _GraphicWalker_ is rendering the chart, it returns `rendering`.
+     * - If rendering is finished, it returns `idle`.
+     * - If an error occurs during the process above, it returns `error`.
+     */
+    get renderStatus(): IRenderStatus;
+    /**
+     * Registers a callback function to listen to the status change of the current chart.
+     *
+     * @param {(renderStatus: IRenderStatus) => void} cb - the callback function
+     * @returns {() => void} a dispose function to remove this callback
+     */
+    onRenderStatusChange: (cb: (renderStatus: IRenderStatus) => void) => (() => void);
+    /**
+     * Exports the current chart.
+     *
+     * @param {IChartExportResult['mode']} [mode='svg'] - the export mode, either `svg` or `data-url`
+     */
     exportChart: IExportChart;
+    /**
+     * Exports all charts.
+     *
+     * @param {IChartExportResult['mode']} [mode='svg'] - the export mode, either `svg` or `data-url`
+     * @returns {AsyncGenerator<IChartListExportResult, void, unknown>} an async generator to iterate over all charts
+     * @example
+     * ```ts
+     * for await (const chart of gwRef.current.exportChartList()) {
+     *     console.log(chart);
+     * }
+     * ```
+     */
+    exportChartList: IExportChartList;
+}
+export interface IGWHandlerInsider extends IGWHandler {
+    updateRenderStatus: (renderStatus: IRenderStatus) => void;
 }
 export {};

package/dist/renderer/pureRenderer.d.ts

@@ -1,13 +1,5 @@
-import React from 'react';
-import type { IDarkMode, IRow, IThemeKey, DraggableFieldState, IVisualConfig } from '../interfaces';
-import type { IReactVegaHandler } from '../vis/react-vega';
-interface IPureRendererProps {
-    name?: string;
-    themeKey?: IThemeKey;
-    dark?: IDarkMode;
-    rawData?: IRow[];
-    visualState: DraggableFieldState;
-    visualConfig: IVisualConfig;
-}
-declare const _default: React.MemoExoticComponent<React.ForwardRefExoticComponent<Pick<IPureRendererProps & React.RefAttributes<IReactVegaHandler>, "key" | keyof IPureRendererProps> & React.RefAttributes<IReactVegaHandler>>>;
+/// <reference types="react" />
+declare const _default: ((props: object) => JSX.Element) & {
+    displayName: string;
+};
 export default _default;

package/dist/utils/chartIndexControl.d.ts

@@ -0,0 +1,7 @@
+interface IUseChartIndexControlOptions {
+    count: number;
+    index: number;
+    onChange: (index: number) => void;
+}
+export declare const useChartIndexControl: (options: IUseChartIndexControlOptions) => void;
+export {};

package/dist/utils/vegaApiExport.d.ts

@@ -1,10 +1,4 @@
-import { type ForwardedRef, type MutableRefObject } from "react";
-import type { View } from "vega";
+import { type ForwardedRef, type MutableRefObject, RefObject } from "react";
 import type { IReactVegaHandler } from "../vis/react-vega";
-export declare const useVegaExportApi: (name: string | undefined, viewsRef: MutableRefObject<{
-    x: number;
-    y: number;
-    w: number;
-    h: number;
-    view: View;
-}[]>, ref: ForwardedRef<IReactVegaHandler>) => void;
+import type { IVegaChartRef } from "../interfaces";
+export declare const useVegaExportApi: (name: string | undefined, viewsRef: MutableRefObject<IVegaChartRef[]>, ref: ForwardedRef<IReactVegaHandler>, renderTaskRefs: MutableRefObject<Promise<unknown>[]>, containerRef: RefObject<HTMLDivElement>) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kanaries/graphic-walker",
-  "version": "0.3.11",
+  "version": "0.3.13",
   "scripts": {
     "dev:front_end": "vite --host",
     "dev": "npm run dev:front_end",
@@ -38,6 +38,7 @@
     "@heroicons/react": "^2.0.8",
     "@kanaries/react-beautiful-dnd": "0.0.2",
     "@kanaries/web-data-loader": "^0.1.7",
+    "@tailwindcss/forms": "^0.5.4",
     "autoprefixer": "^10.3.5",
     "i18next": "^21.9.1",
     "i18next-browser-languagedetector": "^6.1.5",