plotters-skill 0.1.0

package/wasm/plotters_skill_wasm.d.ts

@@ -0,0 +1,422 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * A flexible Cartesian axes that supports mixed series (line, scatter, bar,
+ * step, area) — similar to matplotlib's `Axes` object.
+ */
+export class Axes {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Add a vertical bar series, similar to `ax.bar(x, height)`.
+     */
+    bar(x: Float64Array, heights: Float64Array, options: any): void;
+    /**
+     * `ChartBuilder::build_cartesian_2d(x_min..x_max, y_min..y_max)` shorthand.
+     */
+    buildCartesian2d(x_min: number, x_max: number, y_min: number, y_max: number): void;
+    captionFontFamily(family: string): void;
+    captionFontSize(size: number): void;
+    clear(): void;
+    /**
+     * Configure mesh/grid — maps to plotters' `chart.configure_mesh()`.
+     */
+    configureMesh(options: any): void;
+    /**
+     * Configure legend — maps to plotters' `chart.configure_series_labels()`.
+     */
+    configureSeriesLabels(options: any): void;
+    /**
+     * Render onto an HTML canvas element.
+     */
+    draw(canvas: HTMLCanvasElement): void;
+    figsize(w: number, h: number): void;
+    /**
+     * Add a filled-area series, similar to `ax.fill_between(x, y1)`.
+     */
+    fillBetween(x: Float64Array, y1: Float64Array, options: any): void;
+    grid(show: boolean): void;
+    legend(show: boolean): void;
+    margin(px: number): void;
+    marginBottom(px: number): void;
+    marginLeft(px: number): void;
+    marginRight(px: number): void;
+    marginTop(px: number): void;
+    /**
+     * Add a line series, similar to `ax.plot(x, y)`.
+     */
+    plot(x: Float64Array, y: Float64Array, options: any): void;
+    /**
+     * Render to SVG string.
+     */
+    render(): string;
+    rightYLabelAreaSize(px: number): void;
+    /**
+     * Add a scatter series, similar to `ax.scatter(x, y)`.
+     */
+    scatter(x: Float64Array, y: Float64Array, options: any): void;
+    /**
+     * Add a step-function series, similar to `ax.step(x, y)`.
+     */
+    step(x: Float64Array, y: Float64Array, options: any): void;
+    title(t: string): void;
+    topXLabelAreaSize(px: number): void;
+    xLabelAreaSize(px: number): void;
+    xlabel(l: string): void;
+    xlim(lo: number, hi: number): void;
+    yLabelAreaSize(px: number): void;
+    ylabel(l: string): void;
+    ylim(lo: number, hi: number): void;
+}
+
+/**
+ * A figure/canvas for creating plots, mirroring matplotlib's pyplot interface.
+ *
+ * All rendering outputs SVG (no bitmap/font dependencies in WASM).
+ */
+export class Figure {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Add a box plot, similar to `plt.boxplot(datasets, tick_labels=..., showmeans=...)`.
+     *
+     * `datasets` is a JS array of arrays — each inner array produces one box.
+     */
+    boxplot(datasets: any, options: any): void;
+    /**
+     * Add a candlestick chart, similar to `mplfinance.plot(df, type='candle')`.
+     *
+     * `data` is a JS array of `[open, high, low, close]` arrays.
+     */
+    candlestick(data: any, options: any): void;
+    /**
+     * Remove all plot elements, keeping title / labels / dimensions.
+     *
+     * Use this between frames when animating on a canvas:
+     * ```js
+     * fig.clear();
+     * fig.plot(newX, newY, { color: 'blue' });
+     * fig.draw(canvas);
+     * ```
+     */
+    clear(): void;
+    /**
+     * Render the figure directly onto an HTML `<canvas>` element.
+     *
+     * ```js
+     * const canvas = document.getElementById('my-canvas');
+     * fig.draw(canvas);
+     * ```
+     */
+    draw(canvas: HTMLCanvasElement): void;
+    /**
+     * Set figure dimensions in pixels.
+     */
+    figsize(width: number, height: number): void;
+    /**
+     * Add an area chart, similar to `plt.fill_between(x, y1, y2=0, color=..., alpha=...)`.
+     */
+    fillBetween(x: Float64Array, y1: Float64Array, options: any): void;
+    /**
+     * Show or hide grid lines.
+     */
+    grid(show: boolean): void;
+    /**
+     * Add a histogram, similar to `plt.hist(data, bins=10, ...)`.
+     *
+     * `options` is a JS object with optional keys: `bins`, `color`, `alpha`,
+     * `label`, `rangeMin`, `rangeMax`.
+     */
+    hist(data: Float64Array, options: any): void;
+    /**
+     * Set chart margin in pixels.
+     */
+    margin(pixels: number): void;
+    /**
+     * Add a pie or donut chart, similar to `plt.pie(values, labels=..., colors=...)`.
+     */
+    pie(values: Float64Array, options: any): void;
+    /**
+     * Add a line series, similar to `plt.plot(x, y, color=..., label=...)`.
+     */
+    plot(x: Float64Array, y: Float64Array, options: any): void;
+    /**
+     * Render the figure to an SVG string.
+     *
+     * In the browser, inject the result into the DOM:
+     * ```js
+     * document.getElementById('chart').innerHTML = fig.render();
+     * ```
+     */
+    render(): string;
+    /**
+     * Set the figure title.
+     */
+    title(title: string): void;
+    /**
+     * Set the x-axis label.
+     */
+    xlabel(label: string): void;
+    /**
+     * Set explicit x-axis limits, similar to `ax.set_xlim(min, max)`.
+     */
+    xlim(min: number, max: number): void;
+    /**
+     * Set the y-axis label.
+     */
+    ylabel(label: string): void;
+    /**
+     * Set explicit y-axis limits, similar to `ax.set_ylim(min, max)`.
+     */
+    ylim(min: number, max: number): void;
+}
+
+/**
+ * A flexible multi-row figure layout where each row can have a different
+ * number of columns.
+ */
+export class GridFigure {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Add a new row with `ncols` columns.
+     */
+    addRow(ncols: number): void;
+    /**
+     * Get the figure at `(row, col)` as a standalone `Figure`.
+     *
+     * Configure it, then put it back with `setAx(row, col, fig)`.
+     */
+    ax(row: number, col: number): Figure;
+    /**
+     * Render the grid figure directly onto an HTML `<canvas>` element.
+     */
+    draw(canvas: HTMLCanvasElement): void;
+    /**
+     * Set the overall figure size in pixels.
+     */
+    figsize(width: number, height: number): void;
+    /**
+     * Number of columns in a specific row.
+     */
+    ncols(row: number): number;
+    /**
+     * Number of rows in the grid.
+     */
+    nrows(): number;
+    /**
+     * Render the grid figure to an SVG string.
+     */
+    render(): string;
+    /**
+     * Put a configured figure back into the grid at `(row, col)`.
+     */
+    setAx(row: number, col: number, fig: Figure): void;
+    /**
+     * Set the overall super-title for the grid.
+     */
+    suptitle(title: string): void;
+}
+
+/**
+ * A grid of sub-figures, similar to matplotlib's `fig, axes = plt.subplots(nrows, ncols)`.
+ */
+export class SubPlots {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Get the figure at `(row, col)` as a standalone `Figure`.
+     *
+     * Configure it, then put it back with `setAx(row, col, fig)`.
+     */
+    ax(row: number, col: number): Figure;
+    /**
+     * Render the subplot grid directly onto an HTML `<canvas>` element.
+     */
+    draw(canvas: HTMLCanvasElement): void;
+    /**
+     * Set the overall figure size in pixels.
+     */
+    figsize(width: number, height: number): void;
+    /**
+     * Number of columns in the grid.
+     */
+    ncols(): number;
+    /**
+     * Number of rows in the grid.
+     */
+    nrows(): number;
+    /**
+     * Render the subplot grid to an SVG string.
+     */
+    render(): string;
+    /**
+     * Put a configured figure back into the grid at `(row, col)`.
+     */
+    setAx(row: number, col: number, fig: Figure): void;
+    /**
+     * Set the overall super-title for the grid.
+     */
+    suptitle(title: string): void;
+}
+
+/**
+ * Create a new flexible Axes, similar to `fig, ax = plt.subplots()`.
+ */
+export function axes(): Axes;
+
+/**
+ * Create a new figure, equivalent to `plt.figure()`.
+ */
+export function figure(): Figure;
+
+/**
+ * Create an empty grid figure. Add rows with `addRow(ncols)`.
+ *
+ * Unlike `subplots(nrows, ncols)` which creates a uniform grid, `gridFigure()`
+ * lets each row have a different number of columns.
+ *
+ * ```js
+ * const grid = gridFigure();
+ * grid.addRow(2);  // row 0: two columns
+ * grid.addRow(1);  // row 1: one full-width column
+ * grid.figsize(1200, 800);
+ * grid.suptitle("Mixed Layout");
+ *
+ * let ax = grid.ax(0, 0);
+ * ax.hist(data, { bins: 10 });
+ * grid.setAx(0, 0, ax);
+ *
+ * document.getElementById('chart').innerHTML = grid.render();
+ * ```
+ */
+export function gridFigure(): GridFigure;
+
+/**
+ * Create a subplot grid, equivalent to `plt.subplots(nrows, ncols)`.
+ *
+ * Returns a grid of figures that can each hold their own chart.
+ *
+ * ```js
+ * const grid = subplots(2, 2);
+ * const ax = grid.ax(0, 0);
+ * ax.hist(data, { bins: 10 });
+ * ax.title("Distribution");
+ * grid.setAx(0, 0, ax);
+ * document.getElementById('chart').innerHTML = grid.render();
+ * ```
+ */
+export function subplots(nrows: number, ncols: number): SubPlots;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_axes_free: (a: number, b: number) => void;
+    readonly __wbg_figure_free: (a: number, b: number) => void;
+    readonly __wbg_gridfigure_free: (a: number, b: number) => void;
+    readonly __wbg_subplots_free: (a: number, b: number) => void;
+    readonly axes: () => number;
+    readonly axes_bar: (a: number, b: number, c: number, d: number, e: number, f: any) => [number, number];
+    readonly axes_buildCartesian2d: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly axes_captionFontFamily: (a: number, b: number, c: number) => void;
+    readonly axes_captionFontSize: (a: number, b: number) => void;
+    readonly axes_clear: (a: number) => void;
+    readonly axes_configureMesh: (a: number, b: any) => [number, number];
+    readonly axes_configureSeriesLabels: (a: number, b: any) => [number, number];
+    readonly axes_draw: (a: number, b: any) => [number, number];
+    readonly axes_figsize: (a: number, b: number, c: number) => void;
+    readonly axes_fillBetween: (a: number, b: number, c: number, d: number, e: number, f: any) => [number, number];
+    readonly axes_grid: (a: number, b: number) => void;
+    readonly axes_legend: (a: number, b: number) => void;
+    readonly axes_margin: (a: number, b: number) => void;
+    readonly axes_marginBottom: (a: number, b: number) => void;
+    readonly axes_marginLeft: (a: number, b: number) => void;
+    readonly axes_marginRight: (a: number, b: number) => void;
+    readonly axes_marginTop: (a: number, b: number) => void;
+    readonly axes_plot: (a: number, b: number, c: number, d: number, e: number, f: any) => [number, number];
+    readonly axes_render: (a: number) => [number, number, number, number];
+    readonly axes_rightYLabelAreaSize: (a: number, b: number) => void;
+    readonly axes_scatter: (a: number, b: number, c: number, d: number, e: number, f: any) => [number, number];
+    readonly axes_step: (a: number, b: number, c: number, d: number, e: number, f: any) => [number, number];
+    readonly axes_title: (a: number, b: number, c: number) => void;
+    readonly axes_topXLabelAreaSize: (a: number, b: number) => void;
+    readonly axes_xLabelAreaSize: (a: number, b: number) => void;
+    readonly axes_xlabel: (a: number, b: number, c: number) => void;
+    readonly axes_xlim: (a: number, b: number, c: number) => void;
+    readonly axes_yLabelAreaSize: (a: number, b: number) => void;
+    readonly axes_ylabel: (a: number, b: number, c: number) => void;
+    readonly axes_ylim: (a: number, b: number, c: number) => void;
+    readonly figure: () => number;
+    readonly figure_boxplot: (a: number, b: any, c: any) => [number, number];
+    readonly figure_candlestick: (a: number, b: any, c: any) => [number, number];
+    readonly figure_clear: (a: number) => void;
+    readonly figure_draw: (a: number, b: any) => [number, number];
+    readonly figure_figsize: (a: number, b: number, c: number) => void;
+    readonly figure_fillBetween: (a: number, b: number, c: number, d: number, e: number, f: any) => [number, number];
+    readonly figure_grid: (a: number, b: number) => void;
+    readonly figure_hist: (a: number, b: number, c: number, d: any) => [number, number];
+    readonly figure_margin: (a: number, b: number) => void;
+    readonly figure_pie: (a: number, b: number, c: number, d: any) => [number, number];
+    readonly figure_plot: (a: number, b: number, c: number, d: number, e: number, f: any) => [number, number];
+    readonly figure_render: (a: number) => [number, number, number, number];
+    readonly figure_title: (a: number, b: number, c: number) => void;
+    readonly figure_xlabel: (a: number, b: number, c: number) => void;
+    readonly figure_ylabel: (a: number, b: number, c: number) => void;
+    readonly gridFigure: () => number;
+    readonly gridfigure_addRow: (a: number, b: number) => void;
+    readonly gridfigure_ax: (a: number, b: number, c: number) => number;
+    readonly gridfigure_draw: (a: number, b: any) => [number, number];
+    readonly gridfigure_figsize: (a: number, b: number, c: number) => void;
+    readonly gridfigure_ncols: (a: number, b: number) => number;
+    readonly gridfigure_nrows: (a: number) => number;
+    readonly gridfigure_render: (a: number) => [number, number, number, number];
+    readonly gridfigure_setAx: (a: number, b: number, c: number, d: number) => void;
+    readonly gridfigure_suptitle: (a: number, b: number, c: number) => void;
+    readonly subplots: (a: number, b: number) => number;
+    readonly subplots_ax: (a: number, b: number, c: number) => number;
+    readonly subplots_draw: (a: number, b: any) => [number, number];
+    readonly subplots_figsize: (a: number, b: number, c: number) => void;
+    readonly subplots_ncols: (a: number) => number;
+    readonly subplots_nrows: (a: number) => number;
+    readonly subplots_render: (a: number) => [number, number, number, number];
+    readonly subplots_setAx: (a: number, b: number, c: number, d: number) => void;
+    readonly subplots_suptitle: (a: number, b: number, c: number) => void;
+    readonly figure_xlim: (a: number, b: number, c: number) => void;
+    readonly figure_ylim: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_exn_store: (a: number) => void;
+    readonly __externref_table_alloc: () => number;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;