@sipemu/ggplot-rs 0.39.0 → 0.41.0

package/dist/ggplot_rs.d.ts

@@ -69,12 +69,74 @@ export interface LayerParams {
     target?: string;
     /** bullet / bullet_vertical: qualitative range band upper bounds. */
     ranges?: number[];
+    /** boxplot: notched box (`notch = TRUE`). */
+    notch?: boolean;
+    /** boxplot: box width ∝ √n. */
+    varwidth?: boolean;
+    /** boxplot: whisker reach in IQRs (default 1.5). */
+    coef?: number;
+    /** boxplot: draw outliers (default true; false also drops them from the scale). */
+    outliers?: boolean;
+    /** boxplot: whisker cap width relative to the box (0 = none). */
+    staplewidth?: number;
+    /** violin: trim to the data range (default true). */
+    trim?: boolean;
+    /** violin: `"area"` (default), `"count"`, `"width"`. */
+    scale?: "area" | "count" | "width";
+    /** violin: draw lines at these sample quantiles. */
+    quantiles?: number[];
+    /** violin: fixed kernel bandwidth (default `bw.nrd0`). */
+    bw?: number;
+    /** violin: bandwidth multiplier. */
+    adjust?: number;
+    /** stat "connect": how consecutive points join (default "hv"). */
+    connection?: "hv" | "vh" | "mid" | "linear";
+    /** stat "summary_hex": summary of the raw `z` column (default "mean"). */
+    fun?: "mean" | "median" | "min" | "max" | "sum";
 }
 
 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 };
+| {
+    type: PositionName; width?: number; height?: number; padding?: number; x?: number; y?: number;
+    /** dodge / dodge2: keep one group's width in slots with fewer groups (default "total"). */
+    preserve?: "total" | "single";
+};
+
+/** A per-aesthetic guide: `"none"`, a colourbar / bins kind, or its options (#409). */
+export type GuideSpec =
+| "none"
+| "legend"
+| "bins"
+| "colourbar"
+| "colorbar"
+| "coloursteps"
+| "colorsteps"
+| {
+    title?: string;
+    reverse?: boolean;
+    type?: "legend" | "colourbar" | "colorbar" | "coloursteps" | "colorsteps" | "bins";
+    /** Bar width / height in px. */
+    barwidth?: number;
+    barheight?: number;
+    nbin?: number;
+    display?: "gradient" | "rectangles";
+    frame?: boolean;
+    ticks?: boolean;
+    even_steps?: boolean;
+    /** coloursteps / bins: label the outer limits too. */
+    show_limits?: boolean;
+    /** bins: draw the axis line and ticks (default true). */
+    axis?: boolean;
+    /** Draw this legend at its own side (the others stay at `legend`). */
+    position?: "right" | "left" | "top" | "bottom";
+    /** Fixed key appearance (ggplot2's override.aes). */
+    override_aes?: {
+        color?: string; fill?: string; shape?: string | number; linetype?: string;
+        size?: number; alpha?: number; linewidth?: number;
+    };
+};
 
 export interface Layer {
     geom: GeomName;
@@ -83,8 +145,17 @@ export interface Layer {
     /** Layer-specific data, replacing the plot's. */
     data?: Data;
     params?: LayerParams;
-    /** Override the geom's default stat; only "identity" is supported. */
-    stat?: "identity";
+    /** Override the geom's default stat: "identity" (plot values as given), "unique"
+     *  (drop duplicate rows), "connect" (steps, see params.connection), "summary_hex"
+     *  (hexagons of params.fun over a `z` column), "sf_coordinates" (a point per WKT
+     *  `geometry`, e.g. text on a map). */
+    stat?: "identity" | "unique" | "connect" | "summary_hex" | "sf_coordinates";
+    /** Legend key picture (ggplot2's key_glyph); default per geom. */
+    key_glyph?: "point" | "path" | "rect" | "polygon" | "boxplot" | "crossbar" | "pointrange"
+    | "linerange" | "smooth" | "text" | "label" | "vline" | "vpath" | "abline" | "timeseries"
+    | "dotplot" | "blank";
+    /** Show this layer in the legends, or per aesthetic: `{ color: true, fill: false }`. */
+    show_legend?: boolean | Partial<Record<"color" | "colour" | "fill" | "shape" | "size" | "alpha" | "linetype" | "linewidth", boolean>>;
     position?: Position;
 }
 
@@ -93,8 +164,19 @@ export interface PositionScale {
     | "probit" | "pseudo_log" | "reciprocal" | "exp";
     limits?: [number, number];
     breaks?: number[];
+    /** About this many breaks (ggplot2's n.breaks). */
+    n_breaks?: number;
+    /** Time-of-day axis: values in seconds, HH:MM:SS labels (scale_x_time). */
+    time?: boolean;
     /** Axis title. */
     name?: string;
+    /** Secondary axis (x: top, y: right): `true` repeats the primary
+     *  (`dup_axis()`), or `secondary = primary * scale + offset`. */
+    sec_axis?: boolean | { name?: string; scale?: number; offset?: number };
+    /** Binned position scale: about this many breaks (scale_x_binned). */
+    binned?: number;
+    /** Log10 minor ticks (guide_axis_logticks), with trans "log10". */
+    logticks?: boolean;
 }
 
 export interface ColorScale {
@@ -107,16 +189,82 @@ export interface ColorScale {
     values?: Record<string, string>;
     /** Two-color gradient `["#low", "#high"]` for a numeric column. */
     gradient?: [string, string];
+    /** Diverging binned `["#low", "#mid", "#high"]` (`scale_*_steps2`), mid at `midpoint` (default 0). */
+    steps2?: [string, string, string];
+    midpoint?: number;
+    /** Bins for `steps2` / `palette: "viridis_b:A"…"viridis_b:H"` (default 5). */
+    bins?: number;
 }
 
-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" };
+/** A size / alpha / linewidth / shape scale: exactly one of these (#408). */
+export interface ValueScale {
+    /** The column already holds the values (shape: `pch` codes or names). */
+    identity?: boolean;
+    /** Manual `{ level: number }` (not for shape). */
+    values?: Record<string, number>;
+    /** Output range `[lo, hi]` (size: radius, ggplot2's `scale_radius`). */
+    range?: [number, number];
+    /** Binned (scale_*_binned): about this many breaks; with `range`. */
+    binned?: number;
+}
 
-export type CoordName = "cartesian" | "flip" | "polar" | "fixed" | "equal" | "radar" | "sf";
+/** A facet strip labeller (#412). */
+export type Labeller =
+| "value" | "both" | "multi_line" | "parsed"
+| { template: string } | { values: Record<string, string> } | { wrap: number }
+| { vars: Record<string, Labeller> };
+
+/** Which panels get axes, and whether inner axes are labelled (#412). */
+export interface FacetAxesSpec {
+    /** Proportional panels (a wrap needs one row / column). */
+    space?: "fixed" | "free_x" | "free_y" | "free";
+    axes?: "margins" | "all" | "all_x" | "all_y";
+    axis_labels?: "all" | "margins";
+}
+
+export type Facet = FacetAxesSpec & (
+| {
+    wrap: string; ncol?: number; scales?: "fixed" | "free" | "free_x" | "free_y";
+    /** "h" (row by row, default) or "v" (column by column). */
+    dir?: "h" | "v";
+    /** First row at the top (default true; ggplot2's as.table). */
+    as_table?: boolean;
+    /** Wrap strip labels at this many characters (label_wrap_gen). */
+    label_wrap?: number;
+    labeller?: Labeller;
+    /** The side of each panel its strip sits on (default "top"). */
+    strip_position?: "top" | "bottom" | "left" | "right";
+    /** Fixed panel order; listed levels without data still get a panel. */
+    levels?: string[];
+}
+| {
+    rows?: string; cols?: string; scales?: "fixed" | "free" | "free_x" | "free_y";
+    labeller?: Labeller;
+    /** Column strips below ("x"), row strips left ("y"), or both. */
+    switch?: "x" | "y" | "both";
+    /** Fixed row / column order, empty ones kept (drop = FALSE). */
+    row_levels?: string[]; col_levels?: string[];
+    /** An extra "(all)" row and column (margins = TRUE). */
+    margins?: boolean;
+});
+
+export type CoordName =
+| "cartesian" | "flip" | "polar" | "radial" | "fixed" | "equal" | "radar" | "quickmap" | "map" | "sf";
 export type Coord =
 | CoordName
-| { type: CoordName; ratio?: number; xlim?: [number, number]; ylim?: [number, number] };
+| {
+    type: CoordName; ratio?: number; xlim?: [number, number]; ylim?: [number, number];
+    /** cartesian: mirror the panel; radial: "theta" | "r" | "thetar". */
+    reverse?: "x" | "y" | "xy" | "theta" | "r" | "thetar" | "none";
+    /** cartesian: keep the scale padding — `false`, or `[top, right, bottom, left]`. */
+    expand?: boolean | [boolean, boolean, boolean, boolean];
+    /** radial: theta start / end in radians (clockwise from 12 o'clock) and a donut hole (0–1). */
+    start?: number; end?: number; inner_radius?: number;
+    /** radial: r axis along the start spoke; theta labels follow the circle. */
+    r_axis_inside?: boolean; rotate_angle?: boolean;
+    /** "on" (default) clips layers to the panel; "off" lets them draw past it. */
+    clip?: "on" | "off";
+};
 
 export interface Labels {
     title?: string;
@@ -127,7 +275,7 @@ export interface Labels {
     y?: string;
 }
 
-export type ThemePreset = "gray" | "grey" | "bw" | "minimal" | "classic" | "dark" | "light" | "void" | "linedraw";
+export type ThemePreset = "gray" | "grey" | "bw" | "minimal" | "classic" | "dark" | "light" | "void" | "linedraw" | "test";
 export interface TextElement {
     family?: string; size?: number; color?: [number, number, number];
     face?: "plain" | "bold" | "italic"; hjust?: number; vjust?: number; angle?: number; visible?: boolean;
@@ -156,8 +304,31 @@ export interface ThemeConfig {
     text?: TextElement; title?: TextElement; subtitle?: TextElement; caption?: TextElement;
     axis_title_x?: TextElement; axis_title_y?: TextElement;
     axis_text_x?: TextElement; axis_text_y?: TextElement;
+    /** A top x axis's / right (secondary) y axis's labels (#413). */
+    axis_text_x_top?: TextElement; axis_text_y_right?: TextElement;
+    /** Horizontal (x) / turned (y) facet strips only (#413). */
+    strip_text_x?: TextElement; strip_text_y?: TextElement;
+    strip_background_x?: RectElement; strip_background_y?: RectElement;
+    /** Strips below / left of a panel outside its axis (#412), and the gap. */
+    strip_placement?: "inside" | "outside"; strip_switch_pad?: number;
+    caption_position?: "panel" | "plot";
+    legend_location?: "panel" | "plot";
+    legend_ticks_length?: number;
+    /** Gaps between legend keys and between the panel and the legend, px (#413). */
+    legend_key_spacing_x?: number; legend_key_spacing_y?: number; legend_box_spacing?: number;
+    /** Line several legends up: "left"/"top" (default), "center", "right"/"bottom", or 0–1. */
+    /** Markdown / HTML subset (**bold**, *italic*, ^sup^, ~sub~, <span style='color:…'>) in titles, strips, legends. */
+    rich_text?: boolean;
+    legend_box_just?: "left" | "top" | "center" | "right" | "bottom" | number;
     legend_title?: TextElement; legend_text?: TextElement; strip_text?: TextElement;
     axis_line?: LineElement; axis_ticks?: LineElement;
+    /** Per-axis / per-side axis lines and ticks (#413). */
+    axis_line_x?: LineElement; axis_line_y?: LineElement;
+    axis_ticks_x?: LineElement; axis_ticks_y?: LineElement;
+    axis_line_x_top?: LineElement; axis_line_x_bottom?: LineElement;
+    axis_line_y_left?: LineElement; axis_line_y_right?: LineElement;
+    axis_ticks_x_top?: LineElement; axis_ticks_x_bottom?: LineElement;
+    axis_ticks_y_left?: LineElement; axis_ticks_y_right?: LineElement;
     panel_grid_major?: LineElement; panel_grid_minor?: LineElement; panel_border?: LineElement;
     panel_background?: RectElement; plot_background?: RectElement;
     legend_background?: RectElement; strip_background?: RectElement;
@@ -173,16 +344,20 @@ export interface PlotSpec {
     /** Plot-level mapping inherited by every layer. */
     aes?: AesMap;
     layers: Layer[];
-    scales?: { x?: PositionScale; y?: PositionScale; color?: ColorScale; colour?: ColorScale; fill?: ColorScale };
+    scales?: { x?: PositionScale; y?: PositionScale; color?: ColorScale; colour?: ColorScale; fill?: ColorScale; size?: ValueScale; alpha?: ValueScale; linewidth?: ValueScale; shape?: ValueScale };
     facet?: Facet;
     coord?: Coord;
     labels?: Labels;
     /** A preset name or a theme overlay (default "minimal"). */
     theme?: ThemePreset | ThemeConfig;
     legend?: Legend;
+    /** Per-aesthetic guides: `"none"` drops a legend, `{ title }` names it. */
+    guides?: Partial<Record<"color" | "colour" | "fill" | "shape" | "size" | "alpha" | "linetype" | "linewidth", GuideSpec>>;
     /** Pixels (default 640 × 400). */
     width?: number;
     height?: number;
+    /** Tag axes, grid, legend, strips and titles with semantic CSS classes (gg-axis-text, gg-legend-key, …). */
+    svg_classes?: boolean;
 }
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sipemu/ggplot-rs",
-  "version": "0.39.0",
+  "version": "0.41.0",
   "description": "Grammar-of-graphics charts (ggplot2-style) rendered to SVG — WebAssembly build of the ggplot-rs Rust crate, no runtime dependencies",
   "type": "module",
   "main": "./dist/ggplot_rs.js",

package/skills/ggplot-rs-js/SKILL.md

@@ -64,17 +64,22 @@ if (!svg.startsWith("<svg")) throw new Error("render failed");
 | `data` | `{ col: (number \| string \| boolean \| null)[] }` — numbers continuous, strings/booleans categorical |
 | `aes` / `layers[].aes` | aesthetic → column: `x y color 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` |
 | `layers[].geom` | see Geoms |
-| `layers[].params` | `bins` · `method` (`"lm"`/`"loess"`) `span` `se` · `yintercept` `xintercept` `slope` `intercept` · `levels` · `rows` · `box_size` `reversal` · `shape` · `speed` `direction` · `censor` · `projection` · `target` `ranges` |
-| `layers[].position` | `identity stack fill dodge dodge2 jitter nudge`, or `{ type: "dodge", width: 0.8 }` |
-| `layers[].stat` | `"identity"` (plot precomputed values, e.g. bar heights) |
+| `layers[].params` | `bins` · `method` (`"lm"`/`"loess"`) `span` `se` · `yintercept` `xintercept` `slope` `intercept` · `levels` · `rows` · `box_size` `reversal` · `shape` · `speed` `direction` · `censor` · `projection` · `target` `ranges` · boxplot `notch` `varwidth` `coef` `outliers` `staplewidth` · violin `trim` `scale` (`"area"`/`"count"`/`"width"`) `quantiles` `bw` `adjust` · stat connect `connection` · stat summary_hex `fun` |
+| `layers[].position` | `identity stack fill dodge dodge2 jitter nudge`, or `{ type: "dodge", width: 0.8, preserve: "single" }`. boxplot dodges (`dodge2`) and violin (`dodge`) by default, so grouped boxes sit side by side |
+| `layers[].stat` | `"identity"` (plot precomputed values, e.g. bar heights), `"unique"` (drop duplicate rows), `"connect"` (steps; `params.connection` `hv`/`vh`/`mid`/`linear`), `"summary_hex"` (`params.fun` of a `z` column per hexagon), `"sf_coordinates"` (a point per WKT `geometry` — text on a map) |
 | `layers[].data` | layer-specific data |
-| `scales.x/y` | `{ trans, limits: [lo, hi], breaks: [...], name }`; trans `log10 log2 ln sqrt reverse logit probit pseudo_log reciprocal exp` |
-| `scales.color/fill` | `{ palette }` (`Set1 Dark2 Paired npg …` categorical; `viridis magma plasma inferno` numeric), `{ values: { level: "#rrggbb" } }`, `{ gradient: ["#lo", "#hi"] }`, `{ levels: [...] }` |
-| `facet` | `{ wrap, ncol?, scales? }` or `{ rows?, cols?, scales? }`; scales `fixed free free_x free_y` |
-| `coord` | `cartesian flip polar fixed radar sf`, or `{ type, xlim, ylim, ratio }` |
+| `layers[].key_glyph` | legend key picture: `point path rect polygon boxplot crossbar pointrange linerange smooth text label vline vpath abline timeseries dotplot blank` (default per geom; layers on one mapping share a key) |
+| `layers[].show_legend` | `false` hides the layer from legends; `{ color: false }` per aesthetic |
+| `scales.x/y` | `{ trans, limits: [lo, hi], breaks: [...], logticks: true (log10 minor ticks), binned: n (bin x before the stat: geom bar → histogram), n_breaks, time: true (seconds → HH:MM:SS), name, sec_axis: true | { name, scale, offset } }` (secondary axis on top / right); trans `log10 log2 ln sqrt reverse logit probit pseudo_log reciprocal exp` |
+| `scales.color/fill` | `{ palette }` (`Set1 Dark2 Paired npg …`, `hue` = ggplot2's default hues, `viridis:A`…`viridis:H` for categorical; `viridis magma plasma inferno` or any Brewer name (a distiller gradient) for numeric), `{ values: { level: "#rrggbb" } }`, `{ gradient: ["#lo", "#hi"] }`, `{ steps2: ["#lo", "#mid", "#hi"], midpoint: 0, bins: 5 }`, `{ palette: "viridis_b:C", bins: 6 }` (binned), `{ levels: [...] }` |
+| `scales.size/alpha/linewidth/shape` | exactly one of `{ identity: true }` (the column holds the values; shape: `pch` codes or names), `{ values: { level: n } }` (not shape), `{ range: [lo, hi] }`, or `{ binned: n, range? }` (binned; its legend is `guide_bins`, see `guides`) |
+| `facet` | `{ wrap, ncol?, scales?, dir?: "h"/"v", as_table?, label_wrap?: width, strip_position?: "top"/"bottom"/"left"/"right", levels?: [...] }` or `{ rows?, cols?, scales?, switch?: "x"/"y"/"both", row_levels?, col_levels?, margins?: true }` (grid: column strips on top, row strips on the right); `labeller: "both" | { template: "n = {value}" } | { values: { a: "Alpha" } } | { vars: { var: <labeller> } }`; both take `axes: "all"/"all_x"/"all_y"` + `axis_labels: "margins"` and `space: "free_x"/"free_y"/"free"`; scales `fixed free free_x free_y` |
+| `coord` | `cartesian flip polar radial fixed radar quickmap map sf`, or `{ type, xlim, ylim, ratio, reverse: "x"/"y"/"xy", expand: false | [top, right, bottom, left], start, end, inner_radius, r_axis_inside, rotate_angle, clip: "off" }` (radial `reverse: "theta"/"r"/"thetar"`) (`quickmap` / `map` = plain lon/lat data; `radial` partial circles / donuts) |
 | `labels` | `title subtitle caption tag x y` (axis titles are not auto-filled from column names) |
-| `theme` | preset `gray bw minimal classic dark light void linedraw` (default `minimal`), or an overlay `{ base, primary: [r,g,b], palette, title: {...}, panel_grid_major: {...}, … }` |
+| `theme` | preset `gray bw minimal classic dark light void linedraw test` (default `minimal`), or an overlay `{ base, primary: [r,g,b], palette, title: {...}, panel_grid_major: {...}, axis_text_x_top: {...}, axis_text_y_right: {...}, strip_text_x/y: {...}, strip_background_x/y: {...}, strip_placement: "outside", rich_text: true (Markdown/HTML subset in titles, strips, legends), … }` |
 | `legend` | `right left top bottom none inside` or `[x, y]` inside the panel |
+| `svg_classes` | `true` tags axes, grid, legend, strips and titles with CSS classes (`gg-axis-text`, `gg-legend-key`, `gg-strip-text`, `gg-title`, …) for restyling; marks always carry `gg-mark gg-<kind>` |
+| `guides` | per aesthetic: `{ fill: "none", color: { title: "Group", reverse: true } }`; continuous colour/fill: `"coloursteps"` or `{ type: "colourbar", barwidth: 20, barheight: 150, nbin: 10, display: "rectangles", frame: false, ticks: false }` (`even_steps`, `show_limits` for steps); binned size/alpha/shape scales: `"bins"` (the default — keys labelled at bin edges) or `{ type: "bins", show_limits: true, axis: false }`, `"legend"` for one key per bin; one legend at its own side: `{ position: "bottom" }`; fixed key looks: `{ override_aes: { size: 4, alpha: 1, shape: "square", color: "#rrggbb" } }` |
 
 ## Geoms