canvasxpress 71.8.0 → 72.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -20,7 +20,7 @@
20
20
  "./package.json": "./package.json"
21
21
  },
22
22
  "title": "CanvasXpress",
23
- "version": "71.8.0",
23
+ "version": "72.0.0",
24
24
  "license": "SEE LICENSE IN LICENSE",
25
25
  "files": [
26
26
  "src",
@@ -50,6 +50,12 @@
50
50
  --cx-color-amber-800: #92400e;
51
51
  --cx-color-black-a35: rgba(0, 0, 0, 0.35);
52
52
  --cx-color-black-a55: rgba(0, 0, 0, 0.55);
53
+ --cx-color-brand-add: #00b4df;
54
+ --cx-color-brand-interact: #ffaa4f;
55
+ --cx-color-brand-data: #eb0000;
56
+ --cx-color-brand-add-a14: rgba(0, 180, 223, 0.14);
57
+ --cx-color-brand-interact-a18: rgba(255, 170, 79, 0.18);
58
+ --cx-color-brand-data-a12: rgba(235, 0, 0, 0.12);
53
59
  /* radius */
54
60
  --cx-radius-none: 0;
55
61
  --cx-radius-sm: 4px;
@@ -145,7 +145,7 @@ export type CXGraphType =
145
145
 
146
146
  /**
147
147
  * Full chart configuration — one property per parameter in the CanvasXpress
148
- * config schema (1782 keys). String enums become open literal
148
+ * config schema (1785 keys). String enums become open literal
149
149
  * unions (except `graphType`, which is closed); `@graphTypes` in a key's JSDoc
150
150
  * lists the graph types it applies to (absent = all). The index signature keeps
151
151
  * obfuscation aliases and any newer key valid. See `CXConfigFor<G>` for the
@@ -3178,9 +3178,9 @@ export interface CXConfig {
3178
3178
  /**
3179
3179
  * Specifies the orientation of one-dimensional graphs
3180
3180
  * @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bullet … (31 types; see CXGraphTypeKeys)
3181
- * @default "horizontal"
3181
+ * @default "vertical"
3182
3182
  */
3183
- graphOrientation?: "horizontal" | "vertical" | false | (string & {});
3183
+ graphOrientation?: "vertical" | "horizontal" | false | (string & {});
3184
3184
  /**
3185
3185
  * Specifies the type of graph to be rendered
3186
3186
  * @default "Bar"
@@ -7781,6 +7781,14 @@ export interface CXConfig {
7781
7781
  * @default false
7782
7782
  */
7783
7783
  showSmpOverlaysLegend?: boolean;
7784
+ /**
7785
+ * Opt-in flag to render the statInference block (pairwise significance brackets +
7786
+ * p-value/stars) on one-dimensional group charts (Boxplot, Violin, Bar). Off by default so
7787
+ * non-stat charts are unaffected.
7788
+ * @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bin … (41 types; see CXGraphTypeKeys)
7789
+ * @default false
7790
+ */
7791
+ showStatInference?: boolean;
7784
7792
  /**
7785
7793
  * Flag to show/hide the shadows in text in the canvas. It will be forced to false if the
7786
7794
  * browser is IE
@@ -8225,6 +8233,20 @@ export interface CXConfig {
8225
8233
  * @default 270
8226
8234
  */
8227
8235
  startPieSectors?: number | boolean;
8236
+ /**
8237
+ * Renderer-first inference layer. An object with a comparisons array, each item {groups: [a,
8238
+ * b] (category names or 1-based positions), p: rawPValue, optional padj, value (bracket
8239
+ * height on the value axis), label, color}. Optional correction {method:
8240
+ * "BH"|"bonferroni"|"BY"|"holm"|"hochberg"|"none"} applies native multiple-testing
8241
+ * correction when padj is not supplied, and annotate ("p"|"padj"|"stars") selects what each
8242
+ * bracket prints. Optional fdrThreshold (number) draws no bracket for a comparison whose
8243
+ * corrected p (raw p when no correction applies) is above it. Test statistics are computed
8244
+ * upstream (R/Python); only correction and star derivation run in the engine. Requires
8245
+ * showStatInference:true.
8246
+ * @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bin … (41 types; see CXGraphTypeKeys)
8247
+ * @default false
8248
+ */
8249
+ statInference?: Record<string, unknown> | unknown[] | boolean | string | number;
8228
8250
  /**
8229
8251
  * Eviction policy applied by pushData() once the sample count exceeds streamWindow.
8230
8252
  * Currently only drop-oldest (remove the oldest samples first) is supported
@@ -9413,6 +9435,16 @@ export interface CXConfig {
9413
9435
  * @default false
9414
9436
  */
9415
9437
  visiumPanning?: boolean;
9438
+ /**
9439
+ * Promotes a Volcano chart (Scatter2D of log2 fold-change vs -log10 p-value) by auto-seeding
9440
+ * significance cut-off lines: {foldChange: <log2 FC cutoff>, fdr: <p/FDR cutoff on the raw
9441
+ * scale>, foldChangeColor, fdrColor, width}. Draws vertical rules at +/- foldChange and a
9442
+ * horizontal rule at -log10(fdr) using the scatter decoration path. Omit to keep the plain
9443
+ * Volcano alias.
9444
+ * @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bin … (41 types; see CXGraphTypeKeys)
9445
+ * @default false
9446
+ */
9447
+ volcano?: Record<string, unknown> | boolean;
9416
9448
  /**
9417
9449
  * Color for the bars decreasing in the waterfall plot
9418
9450
  * @graphTypes Bar
@@ -11713,7 +11745,10 @@ export type CXKeysDecorations =
11713
11745
  | "decorationsWidth"
11714
11746
  | "showDecorations"
11715
11747
  | "showDecorationsBorder"
11716
- | "showDecorationsLegend";
11748
+ | "showDecorationsLegend"
11749
+ | "showStatInference"
11750
+ | "statInference"
11751
+ | "volcano";
11717
11752
  /** Config keys in the "Dendrograms" category. */
11718
11753
  export type CXKeysDendrograms =
11719
11754
  | "colorSmpDendrogramBy"
@@ -154,7 +154,7 @@ declare namespace CanvasXpress {
154
154
 
155
155
  /**
156
156
  * Full chart configuration — one property per parameter in the CanvasXpress
157
- * config schema (1782 keys). String enums become open literal
157
+ * config schema (1785 keys). String enums become open literal
158
158
  * unions (except `graphType`, which is closed); `@graphTypes` in a key's JSDoc
159
159
  * lists the graph types it applies to (absent = all). The index signature keeps
160
160
  * obfuscation aliases and any newer key valid. See `CXConfigFor<G>` for the
@@ -3187,9 +3187,9 @@ declare namespace CanvasXpress {
3187
3187
  /**
3188
3188
  * Specifies the orientation of one-dimensional graphs
3189
3189
  * @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bullet … (31 types; see CXGraphTypeKeys)
3190
- * @default "horizontal"
3190
+ * @default "vertical"
3191
3191
  */
3192
- graphOrientation?: "horizontal" | "vertical" | false | (string & {});
3192
+ graphOrientation?: "vertical" | "horizontal" | false | (string & {});
3193
3193
  /**
3194
3194
  * Specifies the type of graph to be rendered
3195
3195
  * @default "Bar"
@@ -7790,6 +7790,14 @@ declare namespace CanvasXpress {
7790
7790
  * @default false
7791
7791
  */
7792
7792
  showSmpOverlaysLegend?: boolean;
7793
+ /**
7794
+ * Opt-in flag to render the statInference block (pairwise significance brackets +
7795
+ * p-value/stars) on one-dimensional group charts (Boxplot, Violin, Bar). Off by default so
7796
+ * non-stat charts are unaffected.
7797
+ * @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bin … (41 types; see CXGraphTypeKeys)
7798
+ * @default false
7799
+ */
7800
+ showStatInference?: boolean;
7793
7801
  /**
7794
7802
  * Flag to show/hide the shadows in text in the canvas. It will be forced to false if the
7795
7803
  * browser is IE
@@ -8234,6 +8242,20 @@ declare namespace CanvasXpress {
8234
8242
  * @default 270
8235
8243
  */
8236
8244
  startPieSectors?: number | boolean;
8245
+ /**
8246
+ * Renderer-first inference layer. An object with a comparisons array, each item {groups: [a,
8247
+ * b] (category names or 1-based positions), p: rawPValue, optional padj, value (bracket
8248
+ * height on the value axis), label, color}. Optional correction {method:
8249
+ * "BH"|"bonferroni"|"BY"|"holm"|"hochberg"|"none"} applies native multiple-testing
8250
+ * correction when padj is not supplied, and annotate ("p"|"padj"|"stars") selects what each
8251
+ * bracket prints. Optional fdrThreshold (number) draws no bracket for a comparison whose
8252
+ * corrected p (raw p when no correction applies) is above it. Test statistics are computed
8253
+ * upstream (R/Python); only correction and star derivation run in the engine. Requires
8254
+ * showStatInference:true.
8255
+ * @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bin … (41 types; see CXGraphTypeKeys)
8256
+ * @default false
8257
+ */
8258
+ statInference?: Record<string, unknown> | unknown[] | boolean | string | number;
8237
8259
  /**
8238
8260
  * Eviction policy applied by pushData() once the sample count exceeds streamWindow.
8239
8261
  * Currently only drop-oldest (remove the oldest samples first) is supported
@@ -9422,6 +9444,16 @@ declare namespace CanvasXpress {
9422
9444
  * @default false
9423
9445
  */
9424
9446
  visiumPanning?: boolean;
9447
+ /**
9448
+ * Promotes a Volcano chart (Scatter2D of log2 fold-change vs -log10 p-value) by auto-seeding
9449
+ * significance cut-off lines: {foldChange: <log2 FC cutoff>, fdr: <p/FDR cutoff on the raw
9450
+ * scale>, foldChangeColor, fdrColor, width}. Draws vertical rules at +/- foldChange and a
9451
+ * horizontal rule at -log10(fdr) using the scatter decoration path. Omit to keep the plain
9452
+ * Volcano alias.
9453
+ * @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bin … (41 types; see CXGraphTypeKeys)
9454
+ * @default false
9455
+ */
9456
+ volcano?: Record<string, unknown> | boolean;
9425
9457
  /**
9426
9458
  * Color for the bars decreasing in the waterfall plot
9427
9459
  * @graphTypes Bar
@@ -11722,7 +11754,10 @@ declare namespace CanvasXpress {
11722
11754
  | "decorationsWidth"
11723
11755
  | "showDecorations"
11724
11756
  | "showDecorationsBorder"
11725
- | "showDecorationsLegend";
11757
+ | "showDecorationsLegend"
11758
+ | "showStatInference"
11759
+ | "statInference"
11760
+ | "volcano";
11726
11761
  /** Config keys in the "Dendrograms" category. */
11727
11762
  export type CXKeysDendrograms =
11728
11763
  | "colorSmpDendrogramBy"