canvasxpress 70.8.0 → 70.9.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 +1 -1
- package/src/canvasXpress.css +57 -0
- package/src/canvasXpress.d.mts +39 -4
- package/src/canvasXpress.d.ts +39 -4
- package/src/canvasXpress.js +3 -3
package/package.json
CHANGED
package/src/canvasXpress.css
CHANGED
|
@@ -101,6 +101,7 @@
|
|
|
101
101
|
--cx-z-raised: 10;
|
|
102
102
|
--cx-z-toolbar: 1000;
|
|
103
103
|
--cx-z-toolbar-edge: 1001;
|
|
104
|
+
--cx-z-footer-link: 1002;
|
|
104
105
|
--cx-z-resizer: 2000;
|
|
105
106
|
--cx-z-fullscreen: 9999;
|
|
106
107
|
--cx-z-panel: 10000;
|
|
@@ -5633,6 +5634,62 @@ input.cX-DataFilter-Container-Input-Right {
|
|
|
5633
5634
|
background-color: var(--cx-datafilter-background-color, var(--cx-ui-surface));
|
|
5634
5635
|
}
|
|
5635
5636
|
|
|
5637
|
+
/* @category: widget */
|
|
5638
|
+
/*********************/
|
|
5639
|
+
/* Drill breadcrumb */
|
|
5640
|
+
/*********************/
|
|
5641
|
+
|
|
5642
|
+
/* HTML strip overlaid at the top-left of the chart viewport while a drillHierarchy
|
|
5643
|
+
has been drilled into. Not drawn on the canvas, so exports/pixel baselines are
|
|
5644
|
+
untouched. Consumes the shared --cx-ui-* tokens so light/dark mode come for free. */
|
|
5645
|
+
.cX-Drill-Breadcrumb {
|
|
5646
|
+
box-sizing: border-box;
|
|
5647
|
+
position: absolute;
|
|
5648
|
+
top: 4px;
|
|
5649
|
+
left: 4px;
|
|
5650
|
+
z-index: var(--cx-z-panel);
|
|
5651
|
+
display: flex;
|
|
5652
|
+
align-items: center;
|
|
5653
|
+
flex-wrap: wrap;
|
|
5654
|
+
gap: 2px;
|
|
5655
|
+
max-width: calc(100% - 8px);
|
|
5656
|
+
padding: 2px 6px;
|
|
5657
|
+
font-family: var(--cx-font-family);
|
|
5658
|
+
font-size: var(--cx-large-font-size, var(--cx-x-large-font-size));
|
|
5659
|
+
line-height: 1.4;
|
|
5660
|
+
color: var(--cx-font-color, var(--cx-ui-text));
|
|
5661
|
+
background-color: var(--cx-datafilter-toolbar-background-color, var(--cx-ui-chrome));
|
|
5662
|
+
border: 1px var(--cx-border-style) var(--cx-datafilter-border-color, var(--cx-ui-border-accent));
|
|
5663
|
+
border-radius: var(--cx-border-radius);
|
|
5664
|
+
}
|
|
5665
|
+
|
|
5666
|
+
.cX-Drill-Crumb {
|
|
5667
|
+
cursor: pointer;
|
|
5668
|
+
padding: 0px 2px;
|
|
5669
|
+
border-radius: var(--cx-border-radius);
|
|
5670
|
+
text-decoration: none;
|
|
5671
|
+
color: var(--cx-ui-accent, var(--cx-font-color, var(--cx-ui-text)));
|
|
5672
|
+
}
|
|
5673
|
+
|
|
5674
|
+
.cX-Drill-Crumb:hover,
|
|
5675
|
+
.cX-Drill-Crumb:focus {
|
|
5676
|
+
text-decoration: underline;
|
|
5677
|
+
outline: none;
|
|
5678
|
+
}
|
|
5679
|
+
|
|
5680
|
+
.cX-Drill-Sep {
|
|
5681
|
+
opacity: 0.6;
|
|
5682
|
+
padding: 0px 1px;
|
|
5683
|
+
cursor: default;
|
|
5684
|
+
}
|
|
5685
|
+
|
|
5686
|
+
/* The deepest crumb is the current level: plain text, not a link. */
|
|
5687
|
+
.cX-Drill-Current {
|
|
5688
|
+
cursor: default;
|
|
5689
|
+
font-weight: 600;
|
|
5690
|
+
color: var(--cx-font-color, var(--cx-ui-text));
|
|
5691
|
+
text-decoration: none;
|
|
5692
|
+
}
|
|
5636
5693
|
/* @category: widget */
|
|
5637
5694
|
/***************/
|
|
5638
5695
|
/* Toggle */
|
package/src/canvasXpress.d.mts
CHANGED
|
@@ -123,7 +123,7 @@ export type CXGraphType =
|
|
|
123
123
|
|
|
124
124
|
/**
|
|
125
125
|
* Full chart configuration — one property per parameter in the CanvasXpress
|
|
126
|
-
* config schema (
|
|
126
|
+
* config schema (1736 keys). String enums become open literal
|
|
127
127
|
* unions (except `graphType`, which is closed); `@graphTypes` in a key's JSDoc
|
|
128
128
|
* lists the graph types it applies to (absent = all). The index signature keeps
|
|
129
129
|
* obfuscation aliases and any newer key valid. See `CXConfigFor<G>` for the
|
|
@@ -1047,7 +1047,7 @@ export interface CXConfig {
|
|
|
1047
1047
|
* a different color is needed in a particular visualization
|
|
1048
1048
|
* @default "User"
|
|
1049
1049
|
*/
|
|
1050
|
-
colorScheme?: "AAAS" | "Accent" | "BMS" | "BMSBackground" | "BMSBlue" | "BMSBrown" | "BMSGreen" | "BMSPink" | "BMSPrimary" | "BMSSecondary" | "BMSTertiary" | "BMSTertiaryDark" | "BMSTertiaryLight" | "BMSWheat" | "Basic" | "Behance" | "BehancePair" | "BehanceQuartet" | "BehanceTrio" | "Black" | "BlackAndWhite" | "BlueGrey" | "BlueRedGrey" | "Blues" | "BluesDark" | "Bootstrap" | "BrBG" | "Brand" | "Brooklyn99Dark" | "Brooklyn99Regular" | "BuGn" | "BuPu" | "CanvasXpress" | "CanvasXpressOLD" | "CanvasXpressTraditional" | "Cividis" | "ColorBlind" | "ColorSpectrum" | "Colorful" | "ColorfulAlt" | "Complementary" | "Dark2" | "Default" | "Diverging" | "DivergingAlt" | "Economist" | "EconomistBG" | "Excel" | "Excel2" | "Excel3" | "Favorite" | "GGBlanket" | "GGPlot" | "GameOfThronesArryn" | "GameOfThronesGreyjoy" | "GameOfThronesLannister" | "GameOfThronesManderly" | "GameOfThronesMartell" | "GameOfThronesStannis" | "GameOfThronesStark" | "GameOfThronesTargaryen" | "GameOfThronesTully" | "GameOfThronesTyrell" | "GnBu" | "GravityFalls" | "Greens" | "Grey" | "GreyHC" | "Greys" | "Heat" | "Highcharts" | "Inferno" | "JCO" | "Jama" | "KimPossible" | "Lancet" | "LastAirBenderAir" | "LastAirBenderEarth" | "LastAirBenderFire" | "LastAirBenderWater" | "Light" | "Magma" | "Matlab" | "NEJM" | "NPG" | "OrRd" | "Oranges" | "PRGn" | "Paired" | "ParksAndRecreation" | "Parula" | "PaulTol" | "PiYG" | "Plasma" | "Prism" | "PrismPair" | "PrismTrio" | "PuBu" | "PuBuGn" | "PuOr" | "PuRd" | "Purples" | "Rainbow" | "RdBu" | "RdGy" | "RdPu" | "RdYlBu" | "RdYlGn" | "Reds" | "RickyAndMorty" | "Simpsons" | "Solarized" | "SolarizedBase" | "Spectral" | "SpongeBob" | "Stata" | "Stata2" | "Stata3" | "StataMono" | "Tableau" | "TableauBlueRed" | "TableauColorBlind" | "TableauCyclic" | "TableauGreenOrange" | "TableauGrey" | "TableauLight" | "TableauMedium" | "TableauPairSequential" | "TableauPurpleGrey" | "TableauTrafficLight" | "TableauTripleDiverging" | "Viridis" | "ViridisInv" | "WHO" | "WallStreetJournal" | "WallStreetJournal2" | "WallStreetJournal3" | "WallStreetJournalBlackGreen" | "WallStreetJournalDemRep" | "WallStreetJournalRedGreen" | "White" | "YlGn" | "YlGnBu" | "YlOrBr" | "YlOrRd" | false | (string & {});
|
|
1050
|
+
colorScheme?: "User" | "AAAS" | "Accent" | "BMS" | "BMSBackground" | "BMSBlue" | "BMSBrown" | "BMSGreen" | "BMSPink" | "BMSPrimary" | "BMSSecondary" | "BMSTertiary" | "BMSTertiaryDark" | "BMSTertiaryLight" | "BMSWheat" | "Basic" | "Behance" | "BehancePair" | "BehanceQuartet" | "BehanceTrio" | "Black" | "BlackAndWhite" | "BlueGrey" | "BlueRedGrey" | "Blues" | "BluesDark" | "Bootstrap" | "BrBG" | "Brand" | "Brooklyn99Dark" | "Brooklyn99Regular" | "BuGn" | "BuPu" | "CanvasXpress" | "CanvasXpressOLD" | "CanvasXpressTraditional" | "Cividis" | "ColorBlind" | "ColorSpectrum" | "Colorful" | "ColorfulAlt" | "Complementary" | "Dark2" | "Default" | "Diverging" | "DivergingAlt" | "Economist" | "EconomistBG" | "Excel" | "Excel2" | "Excel3" | "Favorite" | "GGBlanket" | "GGPlot" | "GameOfThronesArryn" | "GameOfThronesGreyjoy" | "GameOfThronesLannister" | "GameOfThronesManderly" | "GameOfThronesMartell" | "GameOfThronesStannis" | "GameOfThronesStark" | "GameOfThronesTargaryen" | "GameOfThronesTully" | "GameOfThronesTyrell" | "GnBu" | "GravityFalls" | "Greens" | "Grey" | "GreyHC" | "Greys" | "Heat" | "Highcharts" | "Inferno" | "JCO" | "Jama" | "KimPossible" | "Lancet" | "LastAirBenderAir" | "LastAirBenderEarth" | "LastAirBenderFire" | "LastAirBenderWater" | "Light" | "Magma" | "Matlab" | "NEJM" | "NPG" | "OrRd" | "Oranges" | "PRGn" | "Paired" | "ParksAndRecreation" | "Parula" | "PaulTol" | "PiYG" | "Plasma" | "Prism" | "PrismPair" | "PrismTrio" | "PuBu" | "PuBuGn" | "PuOr" | "PuRd" | "Purples" | "Rainbow" | "RdBu" | "RdGy" | "RdPu" | "RdYlBu" | "RdYlGn" | "Reds" | "RickyAndMorty" | "Simpsons" | "Solarized" | "SolarizedBase" | "Spectral" | "SpongeBob" | "Stata" | "Stata2" | "Stata3" | "StataMono" | "Tableau" | "TableauBlueRed" | "TableauColorBlind" | "TableauCyclic" | "TableauGreenOrange" | "TableauGrey" | "TableauLight" | "TableauMedium" | "TableauPairSequential" | "TableauPurpleGrey" | "TableauTrafficLight" | "TableauTripleDiverging" | "Viridis" | "ViridisInv" | "WHO" | "WallStreetJournal" | "WallStreetJournal2" | "WallStreetJournal3" | "WallStreetJournalBlackGreen" | "WallStreetJournalDemRep" | "WallStreetJournalRedGreen" | "White" | "YlGn" | "YlGnBu" | "YlOrBr" | "YlOrRd" | false | (string & {});
|
|
1051
1051
|
/**
|
|
1052
1052
|
* Name of metadata annotation to color the sample (row) dendrogram
|
|
1053
1053
|
* @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Circular … (21 types; see CXGraphTypeKeys)
|
|
@@ -2104,6 +2104,13 @@ export interface CXConfig {
|
|
|
2104
2104
|
* @default "ends"
|
|
2105
2105
|
*/
|
|
2106
2106
|
dataValuesFrequency?: "all" | "first" | "last" | "ends" | false | (string & {});
|
|
2107
|
+
/**
|
|
2108
|
+
* Flag to hide a data value label that does not fit inside its stacked bar segment
|
|
2109
|
+
* (showDataValues in Stacked graphs), instead of drawing it over the neighbouring segments
|
|
2110
|
+
* @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bullet … (31 types; see CXGraphTypeKeys)
|
|
2111
|
+
* @default false
|
|
2112
|
+
*/
|
|
2113
|
+
dataValuesHideOverlap?: boolean;
|
|
2107
2114
|
/**
|
|
2108
2115
|
* Position for the data values in line graphs
|
|
2109
2116
|
* @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bullet … (31 types; see CXGraphTypeKeys)
|
|
@@ -2437,6 +2444,22 @@ export interface CXConfig {
|
|
|
2437
2444
|
* @default "normal"
|
|
2438
2445
|
*/
|
|
2439
2446
|
dotplotType?: "arrow" | "bullet" | "cleveland" | "connected" | "line" | "lineConnected" | "normal" | "stacked" | "transition" | false | (string & {});
|
|
2447
|
+
/**
|
|
2448
|
+
* Flag to show the drill-down breadcrumb strip in the viewport when a drillHierarchy is
|
|
2449
|
+
* active and the chart has been drilled. Set false for API-only drill control
|
|
2450
|
+
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
2451
|
+
* @default true
|
|
2452
|
+
*/
|
|
2453
|
+
drillBreadcrumb?: boolean;
|
|
2454
|
+
/**
|
|
2455
|
+
* An array of sample annotation names, coarse to fine (e.g. ["Region","State","City"]),
|
|
2456
|
+
* defining a drill-down hierarchy. When set, clicking a mark filters to the clicked level
|
|
2457
|
+
* value and regroups by the next finer annotation; a breadcrumb walks back. Each entry must
|
|
2458
|
+
* be a category in the data.x object
|
|
2459
|
+
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
2460
|
+
* @default []
|
|
2461
|
+
*/
|
|
2462
|
+
drillHierarchy?: unknown[] | boolean | string | number;
|
|
2440
2463
|
/**
|
|
2441
2464
|
* Direction of the arrows in arrow dumbbells (dumbbellType arrow): value points each arrow
|
|
2442
2465
|
* at the smaller value; order points from the first variable to the next (before to after)
|
|
@@ -3976,6 +3999,14 @@ export interface CXConfig {
|
|
|
3976
3999
|
* @default false
|
|
3977
4000
|
*/
|
|
3978
4001
|
legendInside?: boolean;
|
|
4002
|
+
/**
|
|
4003
|
+
* What a left/right-justified top or bottom legend (legendHorizontalJustification 0 or 1)
|
|
4004
|
+
* aligns to: the panel (plot area) edge or the whole plot (canvas) edge, like titleAlign
|
|
4005
|
+
* plot::0
|
|
4006
|
+
* @graphTypes Bar, BarLine, Boxplot, Bullet, Cleveland, DotLine … (19 types; see CXGraphTypeKeys)
|
|
4007
|
+
* @default "panel"
|
|
4008
|
+
*/
|
|
4009
|
+
legendJustifyTo?: "panel" | "plot" | false | (string & {});
|
|
3979
4010
|
/**
|
|
3980
4011
|
* Color for the border in legend key background
|
|
3981
4012
|
* @graphTypes Bar, BarLine, Boxplot, Bullet, Cleveland, DotLine … (19 types; see CXGraphTypeKeys)
|
|
@@ -5234,7 +5265,7 @@ export interface CXConfig {
|
|
|
5234
5265
|
* @graphTypes OptionsWall
|
|
5235
5266
|
* @default false
|
|
5236
5267
|
*/
|
|
5237
|
-
optionsWallChain?: string | boolean;
|
|
5268
|
+
optionsWallChain?: Record<string, unknown> | boolean;
|
|
5238
5269
|
/**
|
|
5239
5270
|
* Expiry label shown in the flank panel titles (e.g. "2026-10-17")
|
|
5240
5271
|
* @graphTypes OptionsWall
|
|
@@ -6161,7 +6192,7 @@ export interface CXConfig {
|
|
|
6161
6192
|
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
6162
6193
|
* @default false
|
|
6163
6194
|
*/
|
|
6164
|
-
ribbonBy?: string | boolean;
|
|
6195
|
+
ribbonBy?: string | unknown[] | boolean | number;
|
|
6165
6196
|
/**
|
|
6166
6197
|
* Type of ribbon to create
|
|
6167
6198
|
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
@@ -10997,6 +11028,8 @@ export type CXKeysData =
|
|
|
10997
11028
|
| "dataTextMargin"
|
|
10998
11029
|
| "dataTextRotate"
|
|
10999
11030
|
| "dataTextScaleFontFactor"
|
|
11031
|
+
| "drillBreadcrumb"
|
|
11032
|
+
| "drillHierarchy"
|
|
11000
11033
|
| "groupingFactorLevelsOrder"
|
|
11001
11034
|
| "groupingFactors"
|
|
11002
11035
|
| "groupingFactorsLabelsHide"
|
|
@@ -11670,6 +11703,7 @@ export type CXKeysLegends =
|
|
|
11670
11703
|
| "legendDirection"
|
|
11671
11704
|
| "legendHorizontalJustification"
|
|
11672
11705
|
| "legendInside"
|
|
11706
|
+
| "legendJustifyTo"
|
|
11673
11707
|
| "legendKeyBackgroundBorderColor"
|
|
11674
11708
|
| "legendKeyBackgroundBorderLineType"
|
|
11675
11709
|
| "legendKeyBackgroundBorderSize"
|
|
@@ -12032,6 +12066,7 @@ export type CXKeysPlotArea =
|
|
|
12032
12066
|
| "binned"
|
|
12033
12067
|
| "blockContrast"
|
|
12034
12068
|
| "dataValuesFrequency"
|
|
12069
|
+
| "dataValuesHideOverlap"
|
|
12035
12070
|
| "dataValuesPosition"
|
|
12036
12071
|
| "dotplotOutlineThreshold"
|
|
12037
12072
|
| "guideStyle"
|
package/src/canvasXpress.d.ts
CHANGED
|
@@ -132,7 +132,7 @@ declare namespace CanvasXpress {
|
|
|
132
132
|
|
|
133
133
|
/**
|
|
134
134
|
* Full chart configuration — one property per parameter in the CanvasXpress
|
|
135
|
-
* config schema (
|
|
135
|
+
* config schema (1736 keys). String enums become open literal
|
|
136
136
|
* unions (except `graphType`, which is closed); `@graphTypes` in a key's JSDoc
|
|
137
137
|
* lists the graph types it applies to (absent = all). The index signature keeps
|
|
138
138
|
* obfuscation aliases and any newer key valid. See `CXConfigFor<G>` for the
|
|
@@ -1056,7 +1056,7 @@ declare namespace CanvasXpress {
|
|
|
1056
1056
|
* a different color is needed in a particular visualization
|
|
1057
1057
|
* @default "User"
|
|
1058
1058
|
*/
|
|
1059
|
-
colorScheme?: "AAAS" | "Accent" | "BMS" | "BMSBackground" | "BMSBlue" | "BMSBrown" | "BMSGreen" | "BMSPink" | "BMSPrimary" | "BMSSecondary" | "BMSTertiary" | "BMSTertiaryDark" | "BMSTertiaryLight" | "BMSWheat" | "Basic" | "Behance" | "BehancePair" | "BehanceQuartet" | "BehanceTrio" | "Black" | "BlackAndWhite" | "BlueGrey" | "BlueRedGrey" | "Blues" | "BluesDark" | "Bootstrap" | "BrBG" | "Brand" | "Brooklyn99Dark" | "Brooklyn99Regular" | "BuGn" | "BuPu" | "CanvasXpress" | "CanvasXpressOLD" | "CanvasXpressTraditional" | "Cividis" | "ColorBlind" | "ColorSpectrum" | "Colorful" | "ColorfulAlt" | "Complementary" | "Dark2" | "Default" | "Diverging" | "DivergingAlt" | "Economist" | "EconomistBG" | "Excel" | "Excel2" | "Excel3" | "Favorite" | "GGBlanket" | "GGPlot" | "GameOfThronesArryn" | "GameOfThronesGreyjoy" | "GameOfThronesLannister" | "GameOfThronesManderly" | "GameOfThronesMartell" | "GameOfThronesStannis" | "GameOfThronesStark" | "GameOfThronesTargaryen" | "GameOfThronesTully" | "GameOfThronesTyrell" | "GnBu" | "GravityFalls" | "Greens" | "Grey" | "GreyHC" | "Greys" | "Heat" | "Highcharts" | "Inferno" | "JCO" | "Jama" | "KimPossible" | "Lancet" | "LastAirBenderAir" | "LastAirBenderEarth" | "LastAirBenderFire" | "LastAirBenderWater" | "Light" | "Magma" | "Matlab" | "NEJM" | "NPG" | "OrRd" | "Oranges" | "PRGn" | "Paired" | "ParksAndRecreation" | "Parula" | "PaulTol" | "PiYG" | "Plasma" | "Prism" | "PrismPair" | "PrismTrio" | "PuBu" | "PuBuGn" | "PuOr" | "PuRd" | "Purples" | "Rainbow" | "RdBu" | "RdGy" | "RdPu" | "RdYlBu" | "RdYlGn" | "Reds" | "RickyAndMorty" | "Simpsons" | "Solarized" | "SolarizedBase" | "Spectral" | "SpongeBob" | "Stata" | "Stata2" | "Stata3" | "StataMono" | "Tableau" | "TableauBlueRed" | "TableauColorBlind" | "TableauCyclic" | "TableauGreenOrange" | "TableauGrey" | "TableauLight" | "TableauMedium" | "TableauPairSequential" | "TableauPurpleGrey" | "TableauTrafficLight" | "TableauTripleDiverging" | "Viridis" | "ViridisInv" | "WHO" | "WallStreetJournal" | "WallStreetJournal2" | "WallStreetJournal3" | "WallStreetJournalBlackGreen" | "WallStreetJournalDemRep" | "WallStreetJournalRedGreen" | "White" | "YlGn" | "YlGnBu" | "YlOrBr" | "YlOrRd" | false | (string & {});
|
|
1059
|
+
colorScheme?: "User" | "AAAS" | "Accent" | "BMS" | "BMSBackground" | "BMSBlue" | "BMSBrown" | "BMSGreen" | "BMSPink" | "BMSPrimary" | "BMSSecondary" | "BMSTertiary" | "BMSTertiaryDark" | "BMSTertiaryLight" | "BMSWheat" | "Basic" | "Behance" | "BehancePair" | "BehanceQuartet" | "BehanceTrio" | "Black" | "BlackAndWhite" | "BlueGrey" | "BlueRedGrey" | "Blues" | "BluesDark" | "Bootstrap" | "BrBG" | "Brand" | "Brooklyn99Dark" | "Brooklyn99Regular" | "BuGn" | "BuPu" | "CanvasXpress" | "CanvasXpressOLD" | "CanvasXpressTraditional" | "Cividis" | "ColorBlind" | "ColorSpectrum" | "Colorful" | "ColorfulAlt" | "Complementary" | "Dark2" | "Default" | "Diverging" | "DivergingAlt" | "Economist" | "EconomistBG" | "Excel" | "Excel2" | "Excel3" | "Favorite" | "GGBlanket" | "GGPlot" | "GameOfThronesArryn" | "GameOfThronesGreyjoy" | "GameOfThronesLannister" | "GameOfThronesManderly" | "GameOfThronesMartell" | "GameOfThronesStannis" | "GameOfThronesStark" | "GameOfThronesTargaryen" | "GameOfThronesTully" | "GameOfThronesTyrell" | "GnBu" | "GravityFalls" | "Greens" | "Grey" | "GreyHC" | "Greys" | "Heat" | "Highcharts" | "Inferno" | "JCO" | "Jama" | "KimPossible" | "Lancet" | "LastAirBenderAir" | "LastAirBenderEarth" | "LastAirBenderFire" | "LastAirBenderWater" | "Light" | "Magma" | "Matlab" | "NEJM" | "NPG" | "OrRd" | "Oranges" | "PRGn" | "Paired" | "ParksAndRecreation" | "Parula" | "PaulTol" | "PiYG" | "Plasma" | "Prism" | "PrismPair" | "PrismTrio" | "PuBu" | "PuBuGn" | "PuOr" | "PuRd" | "Purples" | "Rainbow" | "RdBu" | "RdGy" | "RdPu" | "RdYlBu" | "RdYlGn" | "Reds" | "RickyAndMorty" | "Simpsons" | "Solarized" | "SolarizedBase" | "Spectral" | "SpongeBob" | "Stata" | "Stata2" | "Stata3" | "StataMono" | "Tableau" | "TableauBlueRed" | "TableauColorBlind" | "TableauCyclic" | "TableauGreenOrange" | "TableauGrey" | "TableauLight" | "TableauMedium" | "TableauPairSequential" | "TableauPurpleGrey" | "TableauTrafficLight" | "TableauTripleDiverging" | "Viridis" | "ViridisInv" | "WHO" | "WallStreetJournal" | "WallStreetJournal2" | "WallStreetJournal3" | "WallStreetJournalBlackGreen" | "WallStreetJournalDemRep" | "WallStreetJournalRedGreen" | "White" | "YlGn" | "YlGnBu" | "YlOrBr" | "YlOrRd" | false | (string & {});
|
|
1060
1060
|
/**
|
|
1061
1061
|
* Name of metadata annotation to color the sample (row) dendrogram
|
|
1062
1062
|
* @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Circular … (21 types; see CXGraphTypeKeys)
|
|
@@ -2113,6 +2113,13 @@ declare namespace CanvasXpress {
|
|
|
2113
2113
|
* @default "ends"
|
|
2114
2114
|
*/
|
|
2115
2115
|
dataValuesFrequency?: "all" | "first" | "last" | "ends" | false | (string & {});
|
|
2116
|
+
/**
|
|
2117
|
+
* Flag to hide a data value label that does not fit inside its stacked bar segment
|
|
2118
|
+
* (showDataValues in Stacked graphs), instead of drawing it over the neighbouring segments
|
|
2119
|
+
* @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bullet … (31 types; see CXGraphTypeKeys)
|
|
2120
|
+
* @default false
|
|
2121
|
+
*/
|
|
2122
|
+
dataValuesHideOverlap?: boolean;
|
|
2116
2123
|
/**
|
|
2117
2124
|
* Position for the data values in line graphs
|
|
2118
2125
|
* @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bullet … (31 types; see CXGraphTypeKeys)
|
|
@@ -2446,6 +2453,22 @@ declare namespace CanvasXpress {
|
|
|
2446
2453
|
* @default "normal"
|
|
2447
2454
|
*/
|
|
2448
2455
|
dotplotType?: "arrow" | "bullet" | "cleveland" | "connected" | "line" | "lineConnected" | "normal" | "stacked" | "transition" | false | (string & {});
|
|
2456
|
+
/**
|
|
2457
|
+
* Flag to show the drill-down breadcrumb strip in the viewport when a drillHierarchy is
|
|
2458
|
+
* active and the chart has been drilled. Set false for API-only drill control
|
|
2459
|
+
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
2460
|
+
* @default true
|
|
2461
|
+
*/
|
|
2462
|
+
drillBreadcrumb?: boolean;
|
|
2463
|
+
/**
|
|
2464
|
+
* An array of sample annotation names, coarse to fine (e.g. ["Region","State","City"]),
|
|
2465
|
+
* defining a drill-down hierarchy. When set, clicking a mark filters to the clicked level
|
|
2466
|
+
* value and regroups by the next finer annotation; a breadcrumb walks back. Each entry must
|
|
2467
|
+
* be a category in the data.x object
|
|
2468
|
+
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
2469
|
+
* @default []
|
|
2470
|
+
*/
|
|
2471
|
+
drillHierarchy?: unknown[] | boolean | string | number;
|
|
2449
2472
|
/**
|
|
2450
2473
|
* Direction of the arrows in arrow dumbbells (dumbbellType arrow): value points each arrow
|
|
2451
2474
|
* at the smaller value; order points from the first variable to the next (before to after)
|
|
@@ -3985,6 +4008,14 @@ declare namespace CanvasXpress {
|
|
|
3985
4008
|
* @default false
|
|
3986
4009
|
*/
|
|
3987
4010
|
legendInside?: boolean;
|
|
4011
|
+
/**
|
|
4012
|
+
* What a left/right-justified top or bottom legend (legendHorizontalJustification 0 or 1)
|
|
4013
|
+
* aligns to: the panel (plot area) edge or the whole plot (canvas) edge, like titleAlign
|
|
4014
|
+
* plot::0
|
|
4015
|
+
* @graphTypes Bar, BarLine, Boxplot, Bullet, Cleveland, DotLine … (19 types; see CXGraphTypeKeys)
|
|
4016
|
+
* @default "panel"
|
|
4017
|
+
*/
|
|
4018
|
+
legendJustifyTo?: "panel" | "plot" | false | (string & {});
|
|
3988
4019
|
/**
|
|
3989
4020
|
* Color for the border in legend key background
|
|
3990
4021
|
* @graphTypes Bar, BarLine, Boxplot, Bullet, Cleveland, DotLine … (19 types; see CXGraphTypeKeys)
|
|
@@ -5243,7 +5274,7 @@ declare namespace CanvasXpress {
|
|
|
5243
5274
|
* @graphTypes OptionsWall
|
|
5244
5275
|
* @default false
|
|
5245
5276
|
*/
|
|
5246
|
-
optionsWallChain?: string | boolean;
|
|
5277
|
+
optionsWallChain?: Record<string, unknown> | boolean;
|
|
5247
5278
|
/**
|
|
5248
5279
|
* Expiry label shown in the flank panel titles (e.g. "2026-10-17")
|
|
5249
5280
|
* @graphTypes OptionsWall
|
|
@@ -6170,7 +6201,7 @@ declare namespace CanvasXpress {
|
|
|
6170
6201
|
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
6171
6202
|
* @default false
|
|
6172
6203
|
*/
|
|
6173
|
-
ribbonBy?: string | boolean;
|
|
6204
|
+
ribbonBy?: string | unknown[] | boolean | number;
|
|
6174
6205
|
/**
|
|
6175
6206
|
* Type of ribbon to create
|
|
6176
6207
|
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
@@ -11006,6 +11037,8 @@ declare namespace CanvasXpress {
|
|
|
11006
11037
|
| "dataTextMargin"
|
|
11007
11038
|
| "dataTextRotate"
|
|
11008
11039
|
| "dataTextScaleFontFactor"
|
|
11040
|
+
| "drillBreadcrumb"
|
|
11041
|
+
| "drillHierarchy"
|
|
11009
11042
|
| "groupingFactorLevelsOrder"
|
|
11010
11043
|
| "groupingFactors"
|
|
11011
11044
|
| "groupingFactorsLabelsHide"
|
|
@@ -11679,6 +11712,7 @@ declare namespace CanvasXpress {
|
|
|
11679
11712
|
| "legendDirection"
|
|
11680
11713
|
| "legendHorizontalJustification"
|
|
11681
11714
|
| "legendInside"
|
|
11715
|
+
| "legendJustifyTo"
|
|
11682
11716
|
| "legendKeyBackgroundBorderColor"
|
|
11683
11717
|
| "legendKeyBackgroundBorderLineType"
|
|
11684
11718
|
| "legendKeyBackgroundBorderSize"
|
|
@@ -12041,6 +12075,7 @@ declare namespace CanvasXpress {
|
|
|
12041
12075
|
| "binned"
|
|
12042
12076
|
| "blockContrast"
|
|
12043
12077
|
| "dataValuesFrequency"
|
|
12078
|
+
| "dataValuesHideOverlap"
|
|
12044
12079
|
| "dataValuesPosition"
|
|
12045
12080
|
| "dotplotOutlineThreshold"
|
|
12046
12081
|
| "guideStyle"
|