@sipemu/ggplot-rs 0.0.0-stage → 0.38.0

package/dist/ggplot_rs.d.ts

@@ -0,0 +1,318 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/** One data column: numbers → continuous, strings/booleans → categorical, null → missing. */
+export type Column = (number | string | boolean | null)[];
+/** Column-oriented data: `{ column: [values…] }`; all columns the same length. */
+export type Data = Record<string, Column>;
+
+export type Aesthetic =
+| "x" | "y" | "color" | "colour" | "fill" | "size" | "shape" | "alpha" | "group"
+| "linetype" | "linewidth" | "label" | "weight" | "xmin" | "xmax" | "ymin" | "ymax"
+| "xend" | "yend" | "angle" | "radius" | "tooltip" | "from" | "to" | "subgroup"
+| "open" | "high" | "low" | "close" | "lower" | "middle" | "upper" | "fontface" | "class";
+/** Aesthetic → column name. */
+export type AesMap = Partial<Record<Aesthetic, string>>;
+
+export type GeomName =
+| "point" | "jitter" | "line" | "path" | "step" | "area" | "ribbon" | "col" | "bar"
+| "histogram" | "freqpoly" | "density" | "boxplot" | "violin" | "dotplot" | "smooth"
+| "text" | "label" | "errorbar" | "linerange" | "pointrange" | "crossbar" | "segment"
+| "rect" | "tile" | "raster" | "polygon" | "rug" | "count" | "bin2d" | "hex"
+| "density2d" | "contour" | "qq" | "qq_line" | "hline" | "vline" | "abline" | "blank"
+| "waterfall" | "pareto" | "sankey" | "chord" | "treemap" | "sunburst" | "icicle"
+| "funnel" | "stream" | "lollipop" | "dumbbell" | "candlestick" | "ohlc" | "calendar";
+
+export interface LayerParams {
+    /** histogram: bin count. */
+    bins?: number;
+    /** smooth: fitting method (default "lm"). */
+    method?: "lm" | "loess";
+    /** smooth (loess): span (default 0.75). */
+    span?: number;
+    /** smooth: draw the confidence ribbon (default true). */
+    se?: boolean;
+    /** hline (required). */
+    yintercept?: number;
+    /** vline (required). */
+    xintercept?: number;
+    /** abline (slope required, intercept default 0). */
+    slope?: number;
+    intercept?: number;
+    /** sunburst / icicle (required): hierarchy columns, outermost first. */
+    levels?: string[];
+}
+
+export type PositionName = "identity" | "stack" | "fill" | "dodge" | "dodge2" | "jitter" | "nudge";
+export type Position =
+| PositionName
+| { type: PositionName; width?: number; height?: number; padding?: number; x?: number; y?: number };
+
+export interface Layer {
+    geom: GeomName;
+    /** Merged over the plot-level `aes` (layer wins). */
+    aes?: AesMap;
+    /** Layer-specific data, replacing the plot's. */
+    data?: Data;
+    params?: LayerParams;
+    /** Override the geom's default stat; only "identity" is supported. */
+    stat?: "identity";
+    position?: Position;
+}
+
+export interface PositionScale {
+    trans?: "identity" | "log10" | "log2" | "ln" | "log" | "sqrt" | "reverse" | "logit"
+    | "probit" | "pseudo_log" | "reciprocal" | "exp";
+    limits?: [number, number];
+    breaks?: number[];
+    /** Axis title. */
+    name?: string;
+}
+
+export interface ColorScale {
+    /** Discrete ("Set1", "Dark2", "Paired", "npg", "lancet", …) for a categorical
+     *  column; "viridis" | "magma" | "plasma" | "inferno" for a numeric one. */
+    palette?: string;
+    /** Fixed level order for a categorical column. */
+    levels?: string[];
+    /** Manual colors: `{ level: "#rrggbb" }`. */
+    values?: Record<string, string>;
+    /** Two-color gradient `["#low", "#high"]` for a numeric column. */
+    gradient?: [string, string];
+}
+
+export type Facet =
+| { wrap: string; ncol?: number; scales?: "fixed" | "free" | "free_x" | "free_y" }
+| { rows?: string; cols?: string; scales?: "fixed" | "free" | "free_x" | "free_y" };
+
+export type CoordName = "cartesian" | "flip" | "polar" | "fixed" | "equal" | "radar";
+export type Coord =
+| CoordName
+| { type: CoordName; ratio?: number; xlim?: [number, number]; ylim?: [number, number] };
+
+export interface Labels {
+    title?: string;
+    subtitle?: string;
+    caption?: string;
+    tag?: string;
+    x?: string;
+    y?: string;
+}
+
+export type ThemePreset = "gray" | "grey" | "bw" | "minimal" | "classic" | "dark" | "light" | "void" | "linedraw";
+export interface TextElement {
+    family?: string; size?: number; color?: [number, number, number];
+    face?: "plain" | "bold" | "italic"; hjust?: number; vjust?: number; angle?: number; visible?: boolean;
+}
+export interface LineElement {
+    color?: [number, number, number]; width?: number; visible?: boolean;
+    linetype?: "solid" | "dashed" | "dotted" | "dashdot" | "longdash" | "twodash";
+}
+export interface RectElement {
+    fill?: [number, number, number]; color?: [number, number, number]; width?: number; visible?: boolean;
+}
+/** A partial theme overlay (same schema as the CLI's `--theme-config`). */
+export interface ThemeConfig {
+    /** Preset to start from (default "minimal"). */
+    base?: ThemePreset;
+    /** Brand color `[r, g, b]` for single-series geoms. */
+    primary?: [number, number, number];
+    /** Default discrete palette for categorical color/fill mappings. */
+    palette?: string;
+    aspect_ratio?: number;
+    panel_ontop?: boolean;
+    axis_minor_ticks?: boolean;
+    title_position?: "panel" | "plot";
+    tag_position?: "topleft" | "topright" | "bottomleft" | "bottomright";
+    legend_direction?: "vertical" | "horizontal";
+    text?: TextElement; title?: TextElement; subtitle?: TextElement; caption?: TextElement;
+    axis_title_x?: TextElement; axis_title_y?: TextElement;
+    axis_text_x?: TextElement; axis_text_y?: TextElement;
+    legend_title?: TextElement; legend_text?: TextElement; strip_text?: TextElement;
+    axis_line?: LineElement; axis_ticks?: LineElement;
+    panel_grid_major?: LineElement; panel_grid_minor?: LineElement; panel_border?: LineElement;
+    panel_background?: RectElement; plot_background?: RectElement;
+    legend_background?: RectElement; strip_background?: RectElement;
+    [key: string]: unknown;
+}
+
+/** "inside" places the legend automatically in the emptiest panel corner. */
+export type Legend = "right" | "left" | "top" | "bottom" | "none" | "inside" | [number, number];
+
+/** A layered grammar-of-graphics plot, mirroring the ggplot-rs builder. */
+export interface PlotSpec {
+    data: Data;
+    /** Plot-level mapping inherited by every layer. */
+    aes?: AesMap;
+    layers: Layer[];
+    scales?: { x?: PositionScale; y?: PositionScale; color?: ColorScale; colour?: ColorScale; fill?: ColorScale };
+    facet?: Facet;
+    coord?: Coord;
+    labels?: Labels;
+    /** A preset name or a theme overlay (default "minimal"). */
+    theme?: ThemePreset | ThemeConfig;
+    legend?: Legend;
+    /** Pixels (default 640 × 400). */
+    width?: number;
+    height?: number;
+}
+
+
+
+/**
+ * Axes/gridlines frame for a WebGL scatter overlay: the SVG (no marks) plus the
+ * panel rect in pixels and the expanded data domain that maps to the panel edges.
+ */
+export class Frame {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Panel rect `[x, y, width, height]` in pixels.
+     */
+    readonly plot: Float64Array;
+    readonly svg: string;
+    /**
+     * Expanded x range `[min, max]` mapping to the panel's left/right edge.
+     */
+    readonly xdom: Float64Array;
+    readonly ydom: Float64Array;
+}
+
+/**
+ * An SVG plus the build warnings (rows dropped for non-finite values, layers
+ * whose stat produced no data, …).
+ */
+export class RenderResult {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    readonly svg: string;
+    readonly warnings: string[];
+}
+
+/**
+ * Bounding box `[minx, miny, maxx, maxy]` of a spec's `geometry` (WKT array) —
+ * so JS can initialise a pan/zoom (roam) window and zoom around the cursor.
+ */
+export function geo_bounds(spec_json: string): Float64Array;
+
+/**
+ * The geom names {@link render} accepts.
+ */
+export function geoms(): string[];
+
+/**
+ * Render a layered plot spec (a {@link PlotSpec} object or its JSON text) to
+ * an SVG document. Throws an `Error` naming the offending field — unknown
+ * columns list the available ones.
+ */
+export function render(spec: PlotSpec | string): string;
+
+/**
+ * Like {@link render}, but also returns the build warnings.
+ */
+export function renderWithWarnings(spec: PlotSpec | string): RenderResult;
+
+/**
+ * Render a bar chart (SVG, hover tooltips) from `{ category: [String],
+ * value: [Number], width?, height?, title? }`. Bars are coloured by category
+ * with the Set1 palette — matching the scatter's groups for linked views.
+ */
+export function render_bar(spec_json: string): string;
+
+/**
+ * Render a `geom_sf` map from a JSON spec, returning an SVG document.
+ *
+ * Spec fields:
+ * - `geometry`: `[String]` — WKT (required)
+ * - `fill`: `[Number]` — choropleth values (optional)
+ * - `label`: `[String]` — hover labels (optional)
+ * - `fill_name`, `title`: `String` (optional)
+ * - `width`, `height`: `Number` (default 800×600)
+ * - `projection`: `"mercator"` | `"platecarree"` (default) | `"equal-earth"` |
+ *   `"albers-usa"` | `"albers-europe"` | `"utm:<zone>"` / `"utm:<zone>s"` (south,
+ *   zone 1-60)
+ */
+export function render_geo(spec_json: string): string;
+
+/**
+ * Render a histogram (SVG) from a numeric array; `bins` sets the bin count —
+ * drive it from a slider for an interactive histogram. Feature `wasm`.
+ */
+export function render_hist(values: Float64Array, bins: number, width: number, height: number, title: string): string;
+
+/**
+ * General grammar-of-graphics renderer — expose most geoms to JS via a spec:
+ * `{ data: {col:[...]}, geom, aes:{x,y,color,fill,group,size}, title, width,
+ * height, flip, log_x, log_y, palette, bins, smooth:"lm"|"loess" }`. Returns an
+ * SVG document (with hover tooltips where the geom emits them).
+ */
+export function render_plot(spec_json: string): string;
+
+/**
+ * Render just the axes/gridlines (no marks, via `geom_blank`) for the given
+ * data ranges, returning the SVG plus the panel rect and expanded domain — the
+ * frame a WebGL/canvas layer draws points onto.
+ */
+export function scatter_frame(xmin: number, xmax: number, ymin: number, ymax: number, width: number, height: number, title: string): Frame;
+
+/**
+ * The ggplot-rs version this package was built from.
+ */
+export function version(): string;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_frame_free: (a: number, b: number) => void;
+    readonly __wbg_renderresult_free: (a: number, b: number) => void;
+    readonly frame_plot: (a: number) => [number, number];
+    readonly frame_svg: (a: number) => [number, number];
+    readonly frame_xdom: (a: number) => [number, number];
+    readonly frame_ydom: (a: number) => [number, number];
+    readonly geo_bounds: (a: number, b: number) => [number, number, number, number];
+    readonly geoms: () => [number, number];
+    readonly render: (a: any) => [number, number, number, number];
+    readonly renderWithWarnings: (a: any) => [number, number, number];
+    readonly render_bar: (a: number, b: number) => [number, number, number, number];
+    readonly render_geo: (a: number, b: number) => [number, number, number, number];
+    readonly render_hist: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number, number, number];
+    readonly render_plot: (a: number, b: number) => [number, number, number, number];
+    readonly renderresult_svg: (a: number) => [number, number];
+    readonly renderresult_warnings: (a: number) => [number, number];
+    readonly scatter_frame: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => [number, number, number];
+    readonly version: () => [number, number];
+    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 __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __externref_drop_slice: (a: number, b: 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>;