canvasxpress 71.7.0 → 71.9.0

package/package.json

@@ -20,7 +20,7 @@
     "./package.json": "./package.json"
   },
   "title": "CanvasXpress",
-  "version": "71.7.0",
+  "version": "71.9.0",
   "license": "SEE LICENSE IN LICENSE",
   "files": [
     "src",

package/src/canvasXpress.css

@@ -50,6 +50,12 @@
   --cx-color-amber-800: #92400e;
   --cx-color-black-a35: rgba(0, 0, 0, 0.35);
   --cx-color-black-a55: rgba(0, 0, 0, 0.55);
+  --cx-color-brand-add: #00b4df;
+  --cx-color-brand-interact: #ffaa4f;
+  --cx-color-brand-data: #eb0000;
+  --cx-color-brand-add-a14: rgba(0, 180, 223, 0.14);
+  --cx-color-brand-interact-a18: rgba(255, 170, 79, 0.18);
+  --cx-color-brand-data-a12: rgba(235, 0, 0, 0.12);
   /* radius */
   --cx-radius-none: 0;
   --cx-radius-sm: 4px;

package/src/canvasXpress.d.mts

@@ -31,12 +31,34 @@ export interface CXData {
   [key: string]: unknown;
 }
 
-/** The four supported event hooks. `o` is the resolved data object under the cursor. */
+/**
+ * User-event hooks fired by the engine. Each handler is called with
+ * `this` bound to the chart instance and three arguments: `o` (the resolved
+ * data object under the cursor, or null off any element), `e` (the native DOM
+ * event) and `t` (the chart instance — prefer this over `this`).
+ */
 export interface CXEvents {
+  /** A data element is clicked. */
   click?: (o: any, e: MouseEvent, t: CanvasXpressInstance) => void;
+  /** A legend item is clicked. */
+  clicklegend?: (o: any, e: MouseEvent, t: CanvasXpressInstance) => void;
+  /** A data element is double-clicked. */
   dblclick?: (o: any, e: MouseEvent, t: CanvasXpressInstance) => void;
+  /** Fired continuously during a drag operation. */
+  drag?: (o: any, e: MouseEvent, t: CanvasXpressInstance) => void;
+  /** Network graphs: a node drag has finished. */
+  enddragnode?: (o: any, e: MouseEvent, t: CanvasXpressInstance) => void;
+  /** Fired once after rendering completes. */
+  enddraw?: (o: any, e: Event, t: CanvasXpressInstance) => void;
   mousemove?: (o: any, e: MouseEvent, t: CanvasXpressInstance) => void;
   mouseout?: (o: any, e: MouseEvent, t: CanvasXpressInstance) => void;
+  mouseover?: (o: any, e: MouseEvent, t: CanvasXpressInstance) => void;
+  mouseup?: (o: any, e: MouseEvent, t: CanvasXpressInstance) => void;
+  /** The chart was updated by a remote source. */
+  remoteupdate?: (o: any, e: Event, t: CanvasXpressInstance) => void;
+  /** Fired after a selection of data points has been made. */
+  select?: (o: any, e: MouseEvent, t: CanvasXpressInstance) => void;
+  wheel?: (o: any, e: WheelEvent, t: CanvasXpressInstance) => void;
   [key: string]: ((o: any, e: any, t: CanvasXpressInstance) => void) | undefined;
 }
 
@@ -123,7 +145,7 @@ export type CXGraphType =
 
 /**
  * Full chart configuration — one property per parameter in the CanvasXpress
- * config schema (1780 keys). String enums become open literal
+ * config schema (1785 keys). String enums become open literal
  * unions (except `graphType`, which is closed); `@graphTypes` in a key's JSDoc
  * lists the graph types it applies to (absent = all). The index signature keeps
  * obfuscation aliases and any newer key valid. See `CXConfigFor<G>` for the
@@ -1587,10 +1609,13 @@ export interface CXConfig {
   dataPipeline?: unknown[] | boolean | string | number;
   /**
    * Approximate pixel size for the data points in scatter plots, dotplots and boxplots. The
-   * size will be adjusted according to the dimensions of the graph
+   * size will be adjusted according to the dimensions of the graph. Boxplots and dotplots
+   * default to 15 (to match ggplot2 geom_point) unless set explicitly. Set to the string
+   * "auto" to size scatter points from the plot area, damped by the number of points (larger
+   * dots on sparse/large panels, smaller on dense ones)
    * @default 10
    */
-  dataPointSize?: number | boolean;
+  dataPointSize?: number | boolean | "auto";
   /**
    * Factor used to adjust the size of the dataPointSize
    * @default 1
@@ -3153,9 +3178,9 @@ export interface CXConfig {
   /**
    * Specifies the orientation of one-dimensional graphs
    * @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bullet … (31 types; see CXGraphTypeKeys)
-   * @default "horizontal"
+   * @default "vertical"
    */
-  graphOrientation?: "horizontal" | "vertical" | false | (string & {});
+  graphOrientation?: "vertical" | "horizontal" | false | (string & {});
   /**
    * Specifies the type of graph to be rendered
    * @default "Bar"
@@ -6817,6 +6842,14 @@ export interface CXConfig {
    * @default []
    */
   segregateVariablesBy?: unknown[] | boolean | string | number;
+  /**
+   * Flag to make fit lines and confidence areas (regression, loess, forecast, Kaplan-Meier
+   * curves/bands, area/ribbon) clickable: a click selects and broadcasts the data the
+   * fit/curve was computed over (e.g. a KM arm selects its whole cohort)
+   * @graphTypes Scatter2D
+   * @default true
+   */
+  selectableFits?: boolean;
   /**
    * Variable / Sample names of data points (in the data object) to initially select
    * @default []
@@ -7748,6 +7781,14 @@ export interface CXConfig {
    * @default false
    */
   showSmpOverlaysLegend?: boolean;
+  /**
+   * Opt-in flag to render the statInference block (pairwise significance brackets +
+   * p-value/stars) on one-dimensional group charts (Boxplot, Violin, Bar). Off by default so
+   * non-stat charts are unaffected.
+   * @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bin … (41 types; see CXGraphTypeKeys)
+   * @default false
+   */
+  showStatInference?: boolean;
   /**
    * Flag to show/hide the shadows in text in the canvas. It will be forced to false if the
    * browser is IE
@@ -8022,6 +8063,14 @@ export interface CXConfig {
    * @default 0
    */
   smpTextRotate?: number | boolean;
+  /**
+   * Flag to automatically keep the sample (or grouping-factor) labels of vertical
+   * one-dimensional plots horizontal when the longest label fits its band, falling back to
+   * smpTextRotate otherwise. Re-evaluated on resize
+   * @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
+   * @default true
+   */
+  smpTextRotateAuto?: boolean;
   /**
    * Scaling factor used to increase or decrease the sample labels font size in the canvas
    * @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
@@ -8184,6 +8233,20 @@ export interface CXConfig {
    * @default 270
    */
   startPieSectors?: number | boolean;
+  /**
+   * Renderer-first inference layer. An object with a comparisons array, each item {groups: [a,
+   * b] (category names or 1-based positions), p: rawPValue, optional padj, value (bracket
+   * height on the value axis), label, color}. Optional correction {method:
+   * "BH"|"bonferroni"|"BY"|"holm"|"hochberg"|"none"} applies native multiple-testing
+   * correction when padj is not supplied, and annotate ("p"|"padj"|"stars") selects what each
+   * bracket prints. Optional fdrThreshold (number) draws no bracket for a comparison whose
+   * corrected p (raw p when no correction applies) is above it. Test statistics are computed
+   * upstream (R/Python); only correction and star derivation run in the engine. Requires
+   * showStatInference:true.
+   * @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bin … (41 types; see CXGraphTypeKeys)
+   * @default false
+   */
+  statInference?: Record<string, unknown> | unknown[] | boolean | string | number;
   /**
    * Eviction policy applied by pushData() once the sample count exceeds streamWindow.
    * Currently only drop-oldest (remove the oldest samples first) is supported
@@ -9372,6 +9435,16 @@ export interface CXConfig {
    * @default false
    */
   visiumPanning?: boolean;
+  /**
+   * Promotes a Volcano chart (Scatter2D of log2 fold-change vs -log10 p-value) by auto-seeding
+   * significance cut-off lines: {foldChange: <log2 FC cutoff>, fdr: <p/FDR cutoff on the raw
+   * scale>, foldChangeColor, fdrColor, width}. Draws vertical rules at +/- foldChange and a
+   * horizontal rule at -log10(fdr) using the scatter decoration path. Omit to keep the plain
+   * Volcano alias.
+   * @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bin … (41 types; see CXGraphTypeKeys)
+   * @default false
+   */
+  volcano?: Record<string, unknown> | boolean;
   /**
    * Color for the bars decreasing in the waterfall plot
    * @graphTypes Bar
@@ -11326,6 +11399,7 @@ export type CXKeysConfidenceIntervals =
   | "confidenceIntervalColorCoordinate"
   | "confidenceIntervalsMax"
   | "confidenceLevel"
+  | "selectableFits"
   | "showConfidenceIntervals";
 /** Config keys in the "Context Menu" category. */
 export type CXKeysContextMenu =
@@ -11671,7 +11745,10 @@ export type CXKeysDecorations =
   | "decorationsWidth"
   | "showDecorations"
   | "showDecorationsBorder"
-  | "showDecorationsLegend";
+  | "showDecorationsLegend"
+  | "showStatInference"
+  | "statInference"
+  | "volcano";
 /** Config keys in the "Dendrograms" category. */
 export type CXKeysDendrograms =
   | "colorSmpDendrogramBy"
@@ -12585,6 +12662,7 @@ export type CXKeysSamples =
   | "smpTextFontStyle"
   | "smpTextMargin"
   | "smpTextRotate"
+  | "smpTextRotateAuto"
   | "smpTextScaleFontFactor"
   | "smpTitle"
   | "smpTitleAlign"

package/src/canvasXpress.d.ts

@@ -40,12 +40,34 @@ declare namespace CanvasXpress {
     [key: string]: unknown;
   }
 
-  /** The four supported event hooks. `o` is the resolved data object under the cursor. */
+  /**
+   * User-event hooks fired by the engine. Each handler is called with
+   * `this` bound to the chart instance and three arguments: `o` (the resolved
+   * data object under the cursor, or null off any element), `e` (the native DOM
+   * event) and `t` (the chart instance — prefer this over `this`).
+   */
   export interface CXEvents {
+    /** A data element is clicked. */
     click?: (o: any, e: MouseEvent, t: CanvasXpressInstance) => void;
+    /** A legend item is clicked. */
+    clicklegend?: (o: any, e: MouseEvent, t: CanvasXpressInstance) => void;
+    /** A data element is double-clicked. */
     dblclick?: (o: any, e: MouseEvent, t: CanvasXpressInstance) => void;
+    /** Fired continuously during a drag operation. */
+    drag?: (o: any, e: MouseEvent, t: CanvasXpressInstance) => void;
+    /** Network graphs: a node drag has finished. */
+    enddragnode?: (o: any, e: MouseEvent, t: CanvasXpressInstance) => void;
+    /** Fired once after rendering completes. */
+    enddraw?: (o: any, e: Event, t: CanvasXpressInstance) => void;
     mousemove?: (o: any, e: MouseEvent, t: CanvasXpressInstance) => void;
     mouseout?: (o: any, e: MouseEvent, t: CanvasXpressInstance) => void;
+    mouseover?: (o: any, e: MouseEvent, t: CanvasXpressInstance) => void;
+    mouseup?: (o: any, e: MouseEvent, t: CanvasXpressInstance) => void;
+    /** The chart was updated by a remote source. */
+    remoteupdate?: (o: any, e: Event, t: CanvasXpressInstance) => void;
+    /** Fired after a selection of data points has been made. */
+    select?: (o: any, e: MouseEvent, t: CanvasXpressInstance) => void;
+    wheel?: (o: any, e: WheelEvent, t: CanvasXpressInstance) => void;
     [key: string]: ((o: any, e: any, t: CanvasXpressInstance) => void) | undefined;
   }
 
@@ -132,7 +154,7 @@ declare namespace CanvasXpress {
 
   /**
    * Full chart configuration — one property per parameter in the CanvasXpress
-   * config schema (1780 keys). String enums become open literal
+   * config schema (1785 keys). String enums become open literal
    * unions (except `graphType`, which is closed); `@graphTypes` in a key's JSDoc
    * lists the graph types it applies to (absent = all). The index signature keeps
    * obfuscation aliases and any newer key valid. See `CXConfigFor<G>` for the
@@ -1596,10 +1618,13 @@ declare namespace CanvasXpress {
     dataPipeline?: unknown[] | boolean | string | number;
     /**
      * Approximate pixel size for the data points in scatter plots, dotplots and boxplots. The
-     * size will be adjusted according to the dimensions of the graph
+     * size will be adjusted according to the dimensions of the graph. Boxplots and dotplots
+     * default to 15 (to match ggplot2 geom_point) unless set explicitly. Set to the string
+     * "auto" to size scatter points from the plot area, damped by the number of points (larger
+     * dots on sparse/large panels, smaller on dense ones)
      * @default 10
      */
-    dataPointSize?: number | boolean;
+    dataPointSize?: number | boolean | "auto";
     /**
      * Factor used to adjust the size of the dataPointSize
      * @default 1
@@ -3162,9 +3187,9 @@ declare namespace CanvasXpress {
     /**
      * Specifies the orientation of one-dimensional graphs
      * @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bullet … (31 types; see CXGraphTypeKeys)
-     * @default "horizontal"
+     * @default "vertical"
      */
-    graphOrientation?: "horizontal" | "vertical" | false | (string & {});
+    graphOrientation?: "vertical" | "horizontal" | false | (string & {});
     /**
      * Specifies the type of graph to be rendered
      * @default "Bar"
@@ -6826,6 +6851,14 @@ declare namespace CanvasXpress {
      * @default []
      */
     segregateVariablesBy?: unknown[] | boolean | string | number;
+    /**
+     * Flag to make fit lines and confidence areas (regression, loess, forecast, Kaplan-Meier
+     * curves/bands, area/ribbon) clickable: a click selects and broadcasts the data the
+     * fit/curve was computed over (e.g. a KM arm selects its whole cohort)
+     * @graphTypes Scatter2D
+     * @default true
+     */
+    selectableFits?: boolean;
     /**
      * Variable / Sample names of data points (in the data object) to initially select
      * @default []
@@ -7757,6 +7790,14 @@ declare namespace CanvasXpress {
      * @default false
      */
     showSmpOverlaysLegend?: boolean;
+    /**
+     * Opt-in flag to render the statInference block (pairwise significance brackets +
+     * p-value/stars) on one-dimensional group charts (Boxplot, Violin, Bar). Off by default so
+     * non-stat charts are unaffected.
+     * @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bin … (41 types; see CXGraphTypeKeys)
+     * @default false
+     */
+    showStatInference?: boolean;
     /**
      * Flag to show/hide the shadows in text in the canvas. It will be forced to false if the
      * browser is IE
@@ -8031,6 +8072,14 @@ declare namespace CanvasXpress {
      * @default 0
      */
     smpTextRotate?: number | boolean;
+    /**
+     * Flag to automatically keep the sample (or grouping-factor) labels of vertical
+     * one-dimensional plots horizontal when the longest label fits its band, falling back to
+     * smpTextRotate otherwise. Re-evaluated on resize
+     * @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
+     * @default true
+     */
+    smpTextRotateAuto?: boolean;
     /**
      * Scaling factor used to increase or decrease the sample labels font size in the canvas
      * @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
@@ -8193,6 +8242,20 @@ declare namespace CanvasXpress {
      * @default 270
      */
     startPieSectors?: number | boolean;
+    /**
+     * Renderer-first inference layer. An object with a comparisons array, each item {groups: [a,
+     * b] (category names or 1-based positions), p: rawPValue, optional padj, value (bracket
+     * height on the value axis), label, color}. Optional correction {method:
+     * "BH"|"bonferroni"|"BY"|"holm"|"hochberg"|"none"} applies native multiple-testing
+     * correction when padj is not supplied, and annotate ("p"|"padj"|"stars") selects what each
+     * bracket prints. Optional fdrThreshold (number) draws no bracket for a comparison whose
+     * corrected p (raw p when no correction applies) is above it. Test statistics are computed
+     * upstream (R/Python); only correction and star derivation run in the engine. Requires
+     * showStatInference:true.
+     * @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bin … (41 types; see CXGraphTypeKeys)
+     * @default false
+     */
+    statInference?: Record<string, unknown> | unknown[] | boolean | string | number;
     /**
      * Eviction policy applied by pushData() once the sample count exceeds streamWindow.
      * Currently only drop-oldest (remove the oldest samples first) is supported
@@ -9381,6 +9444,16 @@ declare namespace CanvasXpress {
      * @default false
      */
     visiumPanning?: boolean;
+    /**
+     * Promotes a Volcano chart (Scatter2D of log2 fold-change vs -log10 p-value) by auto-seeding
+     * significance cut-off lines: {foldChange: <log2 FC cutoff>, fdr: <p/FDR cutoff on the raw
+     * scale>, foldChangeColor, fdrColor, width}. Draws vertical rules at +/- foldChange and a
+     * horizontal rule at -log10(fdr) using the scatter decoration path. Omit to keep the plain
+     * Volcano alias.
+     * @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bin … (41 types; see CXGraphTypeKeys)
+     * @default false
+     */
+    volcano?: Record<string, unknown> | boolean;
     /**
      * Color for the bars decreasing in the waterfall plot
      * @graphTypes Bar
@@ -11335,6 +11408,7 @@ declare namespace CanvasXpress {
     | "confidenceIntervalColorCoordinate"
     | "confidenceIntervalsMax"
     | "confidenceLevel"
+    | "selectableFits"
     | "showConfidenceIntervals";
   /** Config keys in the "Context Menu" category. */
   export type CXKeysContextMenu =
@@ -11680,7 +11754,10 @@ declare namespace CanvasXpress {
     | "decorationsWidth"
     | "showDecorations"
     | "showDecorationsBorder"
-    | "showDecorationsLegend";
+    | "showDecorationsLegend"
+    | "showStatInference"
+    | "statInference"
+    | "volcano";
   /** Config keys in the "Dendrograms" category. */
   export type CXKeysDendrograms =
     | "colorSmpDendrogramBy"
@@ -12594,6 +12671,7 @@ declare namespace CanvasXpress {
     | "smpTextFontStyle"
     | "smpTextMargin"
     | "smpTextRotate"
+    | "smpTextRotateAuto"
     | "smpTextScaleFontFactor"
     | "smpTitle"
     | "smpTitleAlign"