canvasxpress 72.3.0 → 72.5.0

package/package.json

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

package/src/canvasXpress.d.mts

@@ -145,7 +145,7 @@ export type CXGraphType =
 
 /**
  * Full chart configuration — one property per parameter in the CanvasXpress
- * config schema (1785 keys). String enums become open literal
+ * config schema (1789 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
@@ -1157,6 +1157,14 @@ export interface CXConfig {
    * @default false
    */
   colorLabelBy?: string | boolean;
+  /**
+   * Class names for a stepped colour legend (see colorLegendSteps): one label per colour
+   * class, lowest class first, drawn beside its swatch in place of the numeric class edges,
+   * for example ["a", "b", "c", "d", "e"]. Ignored unless the legend is stepped and the array
+   * has exactly one entry per class
+   * @default []
+   */
+  colorLegendLabels?: unknown[] | boolean | string | number;
   /**
    * Numeric colour legend for binned colouring: equal draws one equal-width swatch per class
    * with every class edge labelled (stepped legend); proportional sizes swatches by their
@@ -1455,7 +1463,10 @@ export interface CXConfig {
   /**
    * Custom legends : Array of objects [{ size : [], shape : [], shapeColor : [], line : [],
    * lineColor : [], lineStart : [], lineEnd : [], text : [], x : number, y : number, title :
-   * string }]
+   * string, paddingX : number, paddingY : number }]. When legendInside is true, paddingX /
+   * paddingY (default 0) inset the legend box from the x,y plotting panel edges so it stays
+   * inside for any legendPosition; an explicit x / y pins the legend instead and ignores the
+   * padding
    * @graphTypes Bar, BarLine, Boxplot, Bullet, Cleveland, DotLine … (19 types; see CXGraphTypeKeys)
    * @default []
    */
@@ -3340,6 +3351,32 @@ export interface CXConfig {
    * @default []
    */
   heatmapCellMarkers?: unknown[] | boolean | string | number;
+  /**
+   * Pixels of empty space (gap) left around each heatmap cell so it renders as a separate
+   * padded tile instead of a contiguous block; 0 (default) keeps cells edge-to-edge. Combine
+   * with colorSpectrumBinned for a discrete-colour tiled heatmap, or use heatmapType "tiled"
+   * @graphTypes Heatmap
+   * @default 0
+   */
+  heatmapCellSpace?: number | boolean;
+  /**
+   * Array of per-cell text labels drawn centered on top of standard heatmap cells, like
+   * Plotly's text matrix. Each entry is an object with a *variable* and *sample* name
+   * identifying the cell plus a *text* string, with optional *color*. Example: [{variable:
+   * "V1", sample: "S3", text: "0.87*"}] to show a correlation value with a significance
+   * asterisk. Unlike showDataValues (which draws every raw cell value), this lets you supply
+   * arbitrary strings so you can append markers such as "*" for p < 0.05 (issue #322)
+   * @graphTypes Heatmap
+   * @default []
+   */
+  heatmapCellText?: unknown[] | boolean | string | number;
+  /**
+   * Color for the default color for heatmap cell text when an entry in heatmapCellText omits
+   * its own color
+   * @graphTypes Heatmap
+   * @default "rgb(0,0,0)"
+   */
+  heatmapCellTextColorColor?: string | boolean;
   /**
    * Flag to collapse cells in heatmaps of type circle or hexagon. If true cells are ploted
    * without outline otherwise the outline is the foreground color
@@ -3405,11 +3442,12 @@ export interface CXConfig {
   heatmapIndicatorWidth?: number | boolean;
   /**
    * Type of Heatmap used to overlay a layer on top of an image. Special for spatial
-   * transcriptomics and UpSet plots
+   * transcriptomics and UpSet plots. "tiled" is a preset for a discrete-colour, padded-cell
+   * heatmap (binned colours + heatmapCellSpace, no cell box)
    * @graphTypes Heatmap
    * @default "normal"
    */
-  heatmapType?: "normal" | "circle" | "hexagon" | "upset" | "correlation" | "split" | false | (string & {});
+  heatmapType?: "normal" | "circle" | "hexagon" | "upset" | "correlation" | "split" | "tiled" | false | (string & {});
   /**
    * Hidden Map features
    * @graphTypes Map
@@ -11352,6 +11390,7 @@ export type CXKeysClustreePlots =
 /** Config keys in the "Colors" category. */
 export type CXKeysColors =
   | "blindnessType"
+  | "colorLegendLabels"
   | "colorLegendSteps"
   | "colorScheme"
   | "colorSpectrum"
@@ -12021,6 +12060,9 @@ export type CXKeysHeatmapGraphs =
   | "heatmapCellMarkerSize"
   | "heatmapCellMarkerWidth"
   | "heatmapCellMarkers"
+  | "heatmapCellSpace"
+  | "heatmapCellText"
+  | "heatmapCellTextColorColor"
   | "heatmapCollapse"
   | "heatmapHighlightByRowCol"
   | "heatmapHighlightByRowColIntersectionColor"

package/src/canvasXpress.d.ts

@@ -154,7 +154,7 @@ declare namespace CanvasXpress {
 
   /**
    * Full chart configuration — one property per parameter in the CanvasXpress
-   * config schema (1785 keys). String enums become open literal
+   * config schema (1789 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
@@ -1166,6 +1166,14 @@ declare namespace CanvasXpress {
      * @default false
      */
     colorLabelBy?: string | boolean;
+    /**
+     * Class names for a stepped colour legend (see colorLegendSteps): one label per colour
+     * class, lowest class first, drawn beside its swatch in place of the numeric class edges,
+     * for example ["a", "b", "c", "d", "e"]. Ignored unless the legend is stepped and the array
+     * has exactly one entry per class
+     * @default []
+     */
+    colorLegendLabels?: unknown[] | boolean | string | number;
     /**
      * Numeric colour legend for binned colouring: equal draws one equal-width swatch per class
      * with every class edge labelled (stepped legend); proportional sizes swatches by their
@@ -1464,7 +1472,10 @@ declare namespace CanvasXpress {
     /**
      * Custom legends : Array of objects [{ size : [], shape : [], shapeColor : [], line : [],
      * lineColor : [], lineStart : [], lineEnd : [], text : [], x : number, y : number, title :
-     * string }]
+     * string, paddingX : number, paddingY : number }]. When legendInside is true, paddingX /
+     * paddingY (default 0) inset the legend box from the x,y plotting panel edges so it stays
+     * inside for any legendPosition; an explicit x / y pins the legend instead and ignores the
+     * padding
      * @graphTypes Bar, BarLine, Boxplot, Bullet, Cleveland, DotLine … (19 types; see CXGraphTypeKeys)
      * @default []
      */
@@ -3349,6 +3360,32 @@ declare namespace CanvasXpress {
      * @default []
      */
     heatmapCellMarkers?: unknown[] | boolean | string | number;
+    /**
+     * Pixels of empty space (gap) left around each heatmap cell so it renders as a separate
+     * padded tile instead of a contiguous block; 0 (default) keeps cells edge-to-edge. Combine
+     * with colorSpectrumBinned for a discrete-colour tiled heatmap, or use heatmapType "tiled"
+     * @graphTypes Heatmap
+     * @default 0
+     */
+    heatmapCellSpace?: number | boolean;
+    /**
+     * Array of per-cell text labels drawn centered on top of standard heatmap cells, like
+     * Plotly's text matrix. Each entry is an object with a *variable* and *sample* name
+     * identifying the cell plus a *text* string, with optional *color*. Example: [{variable:
+     * "V1", sample: "S3", text: "0.87*"}] to show a correlation value with a significance
+     * asterisk. Unlike showDataValues (which draws every raw cell value), this lets you supply
+     * arbitrary strings so you can append markers such as "*" for p < 0.05 (issue #322)
+     * @graphTypes Heatmap
+     * @default []
+     */
+    heatmapCellText?: unknown[] | boolean | string | number;
+    /**
+     * Color for the default color for heatmap cell text when an entry in heatmapCellText omits
+     * its own color
+     * @graphTypes Heatmap
+     * @default "rgb(0,0,0)"
+     */
+    heatmapCellTextColorColor?: string | boolean;
     /**
      * Flag to collapse cells in heatmaps of type circle or hexagon. If true cells are ploted
      * without outline otherwise the outline is the foreground color
@@ -3414,11 +3451,12 @@ declare namespace CanvasXpress {
     heatmapIndicatorWidth?: number | boolean;
     /**
      * Type of Heatmap used to overlay a layer on top of an image. Special for spatial
-     * transcriptomics and UpSet plots
+     * transcriptomics and UpSet plots. "tiled" is a preset for a discrete-colour, padded-cell
+     * heatmap (binned colours + heatmapCellSpace, no cell box)
      * @graphTypes Heatmap
      * @default "normal"
      */
-    heatmapType?: "normal" | "circle" | "hexagon" | "upset" | "correlation" | "split" | false | (string & {});
+    heatmapType?: "normal" | "circle" | "hexagon" | "upset" | "correlation" | "split" | "tiled" | false | (string & {});
     /**
      * Hidden Map features
      * @graphTypes Map
@@ -11361,6 +11399,7 @@ declare namespace CanvasXpress {
   /** Config keys in the "Colors" category. */
   export type CXKeysColors =
     | "blindnessType"
+    | "colorLegendLabels"
     | "colorLegendSteps"
     | "colorScheme"
     | "colorSpectrum"
@@ -12030,6 +12069,9 @@ declare namespace CanvasXpress {
     | "heatmapCellMarkerSize"
     | "heatmapCellMarkerWidth"
     | "heatmapCellMarkers"
+    | "heatmapCellSpace"
+    | "heatmapCellText"
+    | "heatmapCellTextColorColor"
     | "heatmapCollapse"
     | "heatmapHighlightByRowCol"
     | "heatmapHighlightByRowColIntersectionColor"