canvasxpress 70.7.0 → 70.8.1

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.
@@ -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 (1702 keys). String enums become open literal
126
+ * config schema (1734 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
@@ -135,6 +135,13 @@ export interface CXConfig {
135
135
  * @default {}
136
136
  */
137
137
  Rdataset?: Record<string, unknown> | boolean;
138
+ /**
139
+ * Author-written text alternative (alt text) for screen readers. When set it replaces the
140
+ * generated chart summary in the canvas aria-label and is added to SVG exports as their
141
+ * title and description
142
+ * @default false
143
+ */
144
+ a11yDescription?: string | boolean;
138
145
  /**
139
146
  * Flag to ensure the heatmap indicator scales appropriately when the graph is rendered or
140
147
  * the user manually resizes the graph, the adjustAspectRatio flag must be set to true for
@@ -688,6 +695,11 @@ export interface CXConfig {
688
695
  * @default 0.5
689
696
  */
690
697
  bulletWidthRatio?: number | boolean;
698
+ /**
699
+ * Author or organization credit shown in the chart footer, e.g. "Chart: Jane Doe"
700
+ * @default false
701
+ */
702
+ byline?: string | boolean;
691
703
  /**
692
704
  * Flag to cache image in meta data as Base64
693
705
  * @default false
@@ -1010,6 +1022,13 @@ export interface CXConfig {
1010
1022
  * @default false
1011
1023
  */
1012
1024
  colorLabelBy?: string | boolean;
1025
+ /**
1026
+ * Numeric colour legend for binned colouring: equal draws one equal-width swatch per class
1027
+ * with every class edge labelled (stepped legend); proportional sizes swatches by their
1028
+ * value range; auto is equal with a colorSpectrumBreaksMethod, else proportional
1029
+ * @default "auto"
1030
+ */
1031
+ colorLegendSteps?: "auto" | "proportional" | "equal" | false | (string & {});
1013
1032
  /**
1014
1033
  * Title for the color legend
1015
1034
  * @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
@@ -1028,7 +1047,7 @@ export interface CXConfig {
1028
1047
  * a different color is needed in a particular visualization
1029
1048
  * @default "User"
1030
1049
  */
1031
- 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 & {});
1032
1051
  /**
1033
1052
  * Name of metadata annotation to color the sample (row) dendrogram
1034
1053
  * @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Circular … (21 types; see CXGraphTypeKeys)
@@ -1052,6 +1071,13 @@ export interface CXConfig {
1052
1071
  * @default []
1053
1072
  */
1054
1073
  colorSpectrumBreaks?: unknown[] | boolean | string | number;
1074
+ /**
1075
+ * Classify the colorBy values into one colour class per colorSpectrum colour (a classed
1076
+ * choropleth): jenks (natural breaks), quantile (equal count) or equalWidth. Computes the
1077
+ * colorSpectrumBreaks and turns on binned colouring
1078
+ * @default false
1079
+ */
1080
+ colorSpectrumBreaksMethod?: string | boolean;
1055
1081
  /**
1056
1082
  * Color spectrum by factor in heatmaps. The first key represents the name of the factor
1057
1083
  * within the x/z data object. The subsequent keys correspond to each level of that factor.
@@ -1426,6 +1452,15 @@ export interface CXConfig {
1426
1452
  * @default "rgb(255,255,255)"
1427
1453
  */
1428
1454
  dataLabelBackgroundColor?: string | boolean;
1455
+ /**
1456
+ * Number format for the data values drawn on the chart (showDataValues and data labels).
1457
+ * Overrides numberFormat. It could be a preset name (comma, percent, dollar, euro, pound,
1458
+ * yen, compact), a sprintf format string, or an object, i.e. {"locale": "en-US", "style":
1459
+ * "decimal|percent|currency|compact", "currency": "USD", "decimals": 1, "grouping": true,
1460
+ * "prefix": "", "suffix": ""}. Uses Intl.NumberFormat when available
1461
+ * @default false
1462
+ */
1463
+ dataLabelNumberFormat?: string | Record<string, unknown> | boolean;
1429
1464
  /**
1430
1465
  * A declarative dplyr/tidyr data-grammar recipe applied over the tidy substrate BEFORE the
1431
1466
  * chart wrangle. An ordered array of ops: {op:"filter", col, cmp (one of
@@ -1612,8 +1647,9 @@ export interface CXConfig {
1612
1647
  */
1613
1648
  dataTableColAlignment?: Record<string, unknown> | boolean;
1614
1649
  /**
1615
- * Format for the cols in the data table. Key is the sample name and the value is the format
1616
- * string using sprintf notation
1650
+ * Format for the cols in the data table. Key is the sample name and the value is a sprintf
1651
+ * format string, a number-format preset (comma, percent, dollar, euro, pound, yen, compact)
1652
+ * or a number-format object {locale, style, currency, decimals}
1617
1653
  * @default {}
1618
1654
  */
1619
1655
  dataTableColFormat?: Record<string, unknown> | boolean;
@@ -1640,6 +1676,15 @@ export interface CXConfig {
1640
1676
  * @default {}
1641
1677
  */
1642
1678
  dataTableColProperties?: Record<string, unknown> | boolean;
1679
+ /**
1680
+ * In-cell graphics per column of the data table. Key is the column name and the value is bar
1681
+ * (a bar behind the value scaled to the column, from zero when the column has negatives),
1682
+ * {type: bar, color}, or {type: sparkline, columns: [...], color, width, height, showValue}
1683
+ * (a small line of the row values across those columns, replacing the value unless
1684
+ * showValue)
1685
+ * @default {}
1686
+ */
1687
+ dataTableColRenderer?: Record<string, unknown> | boolean;
1643
1688
  /**
1644
1689
  * Number of pixels for the width of cells in the data table
1645
1690
  * @default 180
@@ -1655,6 +1700,18 @@ export interface CXConfig {
1655
1700
  * @default false
1656
1701
  */
1657
1702
  dataTableColored?: boolean;
1703
+ /**
1704
+ * Flag to shrink the data table to the height of its rows when they do not fill the space
1705
+ * (no empty area under the last row); a longer table still scrolls
1706
+ * @default false
1707
+ */
1708
+ dataTableFitHeight?: boolean;
1709
+ /**
1710
+ * Flag to narrow the data table to the width of its columns when they do not fill the space
1711
+ * (no empty area after the last column); a wider table still scrolls
1712
+ * @default false
1713
+ */
1714
+ dataTableFitWidth?: boolean;
1658
1715
  /**
1659
1716
  * Flag to group rows in the data table based on metadata
1660
1717
  * @default false
@@ -1665,6 +1722,13 @@ export interface CXConfig {
1665
1722
  * @default "rgb(255, 255, 255)"
1666
1723
  */
1667
1724
  dataTableHeaderBackgroundColor?: string | boolean;
1725
+ /**
1726
+ * When the data table header cells show their menu, filter and resize icons: always, only
1727
+ * while the header cell is hovered, or auto (on hover with the minimal dataUIStyle, always
1728
+ * otherwise). Sorting arrows and the filter of a filtered column always show
1729
+ * @default "auto"
1730
+ */
1731
+ dataTableHeaderIcons?: "auto" | "always" | "hover" | false | (string & {});
1668
1732
  /**
1669
1733
  * HTML string to use as template for the data table header info
1670
1734
  * @default false
@@ -2033,13 +2097,20 @@ export interface CXConfig {
2033
2097
  * Style for the UI
2034
2098
  * @default "modern"
2035
2099
  */
2036
- dataUIStyle?: "cx" | "stripped" | "modern" | "old" | "bms" | "colorful" | "rdc" | "ngs360" | false | (string & {});
2100
+ dataUIStyle?: "cx" | "stripped" | "minimal" | "modern" | "old" | "bms" | "colorful" | "rdc" | "ngs360" | false | (string & {});
2037
2101
  /**
2038
2102
  * Frequency for the data values in line graphs
2039
2103
  * @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bullet … (31 types; see CXGraphTypeKeys)
2040
2104
  * @default "ends"
2041
2105
  */
2042
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;
2043
2114
  /**
2044
2115
  * Position for the data values in line graphs
2045
2116
  * @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bullet … (31 types; see CXGraphTypeKeys)
@@ -2373,6 +2444,13 @@ export interface CXConfig {
2373
2444
  * @default "normal"
2374
2445
  */
2375
2446
  dotplotType?: "arrow" | "bullet" | "cleveland" | "connected" | "line" | "lineConnected" | "normal" | "stacked" | "transition" | false | (string & {});
2447
+ /**
2448
+ * Direction of the arrows in arrow dumbbells (dumbbellType arrow): value points each arrow
2449
+ * at the smaller value; order points from the first variable to the next (before to after)
2450
+ * @graphTypes Boxplot, Cleveland, DotLine, Dotplot, Dumbbell, Violin
2451
+ * @default "value"
2452
+ */
2453
+ dumbbellArrowDirection?: "value" | "order" | false | (string & {});
2376
2454
  /**
2377
2455
  * Style for the dumbbell plot
2378
2456
  * @graphTypes Boxplot, Cleveland, DotLine, Dotplot, Dumbbell, Violin
@@ -2779,6 +2857,12 @@ export interface CXConfig {
2779
2857
  * @default []
2780
2858
  */
2781
2859
  fontsExternal?: unknown[] | boolean | string | number;
2860
+ /**
2861
+ * Horizontal alignment for the structured chart footer (notes, source, byline, data
2862
+ * download)
2863
+ * @default "left"
2864
+ */
2865
+ footerAlign?: "left" | "center" | "right" | false | (string & {});
2782
2866
  /**
2783
2867
  * Number of future steps to forecast. 0 uses the forecast package default: 10, or two
2784
2868
  * seasons when forecastSeasonLength is greater than 1
@@ -3899,6 +3983,14 @@ export interface CXConfig {
3899
3983
  * @default false
3900
3984
  */
3901
3985
  legendInside?: boolean;
3986
+ /**
3987
+ * What a left/right-justified top or bottom legend (legendHorizontalJustification 0 or 1)
3988
+ * aligns to: the panel (plot area) edge or the whole plot (canvas) edge, like titleAlign
3989
+ * plot::0
3990
+ * @graphTypes Bar, BarLine, Boxplot, Bullet, Cleveland, DotLine … (19 types; see CXGraphTypeKeys)
3991
+ * @default "panel"
3992
+ */
3993
+ legendJustifyTo?: "panel" | "plot" | false | (string & {});
3902
3994
  /**
3903
3995
  * Color for the border in legend key background
3904
3996
  * @graphTypes Bar, BarLine, Boxplot, Bullet, Cleveland, DotLine … (19 types; see CXGraphTypeKeys)
@@ -3942,6 +4034,15 @@ export interface CXConfig {
3942
4034
  * @default 50
3943
4035
  */
3944
4036
  legendMax?: number | boolean;
4037
+ /**
4038
+ * Number format for numeric values displayed in legends (continuous color ramps and size-by
4039
+ * bins). Overrides numberFormat. It could be a preset name (comma, percent, dollar, euro,
4040
+ * pound, yen, compact), a sprintf format string, or an object, i.e. {"locale": "en-US",
4041
+ * "style": "decimal|percent|currency|compact", "currency": "USD", "decimals": 1, "grouping":
4042
+ * true, "prefix": "", "suffix": ""}. Uses Intl.NumberFormat when available
4043
+ * @default false
4044
+ */
4045
+ legendNumberFormat?: string | Record<string, unknown> | boolean;
3945
4046
  /**
3946
4047
  * Object to specify custom order for the levels in the legends. The key of the object is the
3947
4048
  * name of a valid sample or variable annotation included in the data object. The value for
@@ -4334,6 +4435,13 @@ export interface CXConfig {
4334
4435
  * @default false
4335
4436
  */
4336
4437
  manhattanRangeStart?: string | boolean;
4438
+ /**
4439
+ * Color for the region bubbles on maps (sizeBy a sample: a circle per region sized by its
4440
+ * value); the size legend uses it too
4441
+ * @graphTypes Map
4442
+ * @default "rgba(255,0,0,0.6)"
4443
+ */
4444
+ mapBubbleColor?: string | boolean;
4337
4445
  /**
4338
4446
  * Map Latitude Of Origin in degrees. (Applicable to Albers projection only). Default adjusts
4339
4447
  * to USA maps
@@ -4377,6 +4485,20 @@ export interface CXConfig {
4377
4485
  * @default false
4378
4486
  */
4379
4487
  mapId?: string | boolean;
4488
+ /**
4489
+ * Color for the region labels on maps. Defaults to black or white, whichever contrasts with
4490
+ * the region fill
4491
+ * @graphTypes Map
4492
+ * @default false
4493
+ */
4494
+ mapLabelColor?: string | boolean;
4495
+ /**
4496
+ * Map feature property used as the region label (defaults to name, then NAME, then the
4497
+ * region key)
4498
+ * @graphTypes Map
4499
+ * @default false
4500
+ */
4501
+ mapLabelProperty?: string | boolean;
4380
4502
  /**
4381
4503
  * Map Latitude Of Origin in degrees. (Applicable to Albers projection only). Default adjusts
4382
4504
  * to USA maps
@@ -4962,6 +5084,21 @@ export interface CXConfig {
4962
5084
  * @default 1
4963
5085
  */
4964
5086
  nodeSizeScaleFactor?: number | boolean;
5087
+ /**
5088
+ * Footer notes drawn above the source line at the bottom of the chart. Newlines split into
5089
+ * multiple lines
5090
+ * @default false
5091
+ */
5092
+ notes?: string | boolean;
5093
+ /**
5094
+ * Default number format for values displayed in axis ticks, tooltips, legends and data
5095
+ * labels. It could be a preset name (comma, percent, dollar, euro, pound, yen, compact), a
5096
+ * sprintf format string, or an object, i.e. {"locale": "en-US", "style":
5097
+ * "decimal|percent|currency|compact", "currency": "USD", "decimals": 1, "grouping": true,
5098
+ * "prefix": "", "suffix": ""}. Uses Intl.NumberFormat when available
5099
+ * @default false
5100
+ */
5101
+ numberFormat?: string | Record<string, unknown> | boolean;
4965
5102
  /**
4966
5103
  * Sort group keys numerically (type-aware: plain integers, range labels, composite keys)
4967
5104
  * instead of lexicographically
@@ -5112,7 +5249,7 @@ export interface CXConfig {
5112
5249
  * @graphTypes OptionsWall
5113
5250
  * @default false
5114
5251
  */
5115
- optionsWallChain?: string | boolean;
5252
+ optionsWallChain?: Record<string, unknown> | boolean;
5116
5253
  /**
5117
5254
  * Expiry label shown in the flank panel titles (e.g. "2026-10-17")
5118
5255
  * @graphTypes OptionsWall
@@ -5432,11 +5569,19 @@ export interface CXConfig {
5432
5569
  */
5433
5570
  pieSegmentSeparation?: number | boolean;
5434
5571
  /**
5435
- * Position for the pices of the pie
5572
+ * Shape of the pie: a full circle, or a half circle (semicircle, e.g. an election donut with
5573
+ * pieInnerRadius)
5574
+ * @graphTypes Pie
5575
+ * @default "full"
5576
+ */
5577
+ pieShape?: "full" | "half" | false | (string & {});
5578
+ /**
5579
+ * Position for the pices of the pie. parliament draws one dot per seat on a hemicycle (the
5580
+ * values are seat counts), grouped by party from left to right
5436
5581
  * @graphTypes Pie
5437
5582
  * @default "separated"
5438
5583
  */
5439
- pieType?: "separated" | "solid" | false | (string & {});
5584
+ pieType?: "separated" | "solid" | "parliament" | false | (string & {});
5440
5585
  /**
5441
5586
  * Utility to pivot data with a sample annotation
5442
5587
  * @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
@@ -5664,6 +5809,16 @@ export interface CXConfig {
5664
5809
  * @default 1
5665
5810
  */
5666
5811
  rAxisLogTicksWidth?: number | boolean;
5812
+ /**
5813
+ * Locale-aware number format for the tick values in the R axis. Overrides numberFormat for
5814
+ * this axis; an explicit rAxisTickFormat takes precedence over it. It could be a preset name
5815
+ * (comma, percent, dollar, euro, pound, yen, compact), a sprintf format string, or an
5816
+ * object, i.e. {"locale": "en-US", "style": "decimal|percent|currency|compact", "currency":
5817
+ * "USD", "decimals": 1, "grouping": true, "prefix": "", "suffix": ""}
5818
+ * @graphTypes Circular
5819
+ * @default false
5820
+ */
5821
+ rAxisNumberFormat?: string | Record<string, unknown> | boolean;
5667
5822
  /**
5668
5823
  * Flag to show on not the percent in each segment in the R axis
5669
5824
  * @graphTypes Circular
@@ -6003,6 +6158,15 @@ export interface CXConfig {
6003
6158
  * @default true
6004
6159
  */
6005
6160
  resizableY?: boolean;
6161
+ /**
6162
+ * Width-based config overrides applied on render/resize, i.e. [{"maxWidth": 480, "config":
6163
+ * {"legendPosition": "bottom", "fontScaleFontFactor": 0.8}}]. A rule matches when the canvas
6164
+ * width is <= maxWidth and >= minWidth (either bound optional); later rules win on
6165
+ * conflicting keys. Overrides revert automatically when the width stops matching and are
6166
+ * never saved into the configuration
6167
+ * @default []
6168
+ */
6169
+ responsiveRules?: unknown[] | boolean | string | number;
6006
6170
  /**
6007
6171
  * Name of a sample annotation(s) to create a ribbon of each variable in scatter plots. If a
6008
6172
  * single annotation is passed then it will be used as a standard deviation. If two
@@ -6012,7 +6176,7 @@ export interface CXConfig {
6012
6176
  * @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
6013
6177
  * @default false
6014
6178
  */
6015
- ribbonBy?: string | boolean;
6179
+ ribbonBy?: string | unknown[] | boolean | number;
6016
6180
  /**
6017
6181
  * Type of ribbon to create
6018
6182
  * @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
@@ -7049,6 +7213,12 @@ export interface CXConfig {
7049
7213
  * @default false
7050
7214
  */
7051
7215
  showContourLevel?: boolean;
7216
+ /**
7217
+ * Flag to show a "Get the data" link in the chart footer which downloads the current data as
7218
+ * CSV
7219
+ * @default false
7220
+ */
7221
+ showDataDownload?: boolean;
7052
7222
  /**
7053
7223
  * Flag to show/hide the data labels in scatter plots
7054
7224
  * @graphTypes Bin, Binplot, Bump, CDF, Contour, Density … (22 types; see CXGraphTypeKeys)
@@ -7216,6 +7386,13 @@ export interface CXConfig {
7216
7386
  * @default true
7217
7387
  */
7218
7388
  showLineEdgeLegend?: boolean;
7389
+ /**
7390
+ * Flag to show/hide the series name at the end of each line in line graphs, in the series
7391
+ * color, replacing the legend (direct labeling). Overlapping labels are nudged apart
7392
+ * @graphTypes Area, AreaLine, BarLine, DotLine, Line, ParallelCoordinates … (9 types; see CXGraphTypeKeys)
7393
+ * @default false
7394
+ */
7395
+ showLineEndLabels?: boolean;
7219
7396
  /**
7220
7397
  * Flag to show/hide the legend line
7221
7398
  * @graphTypes Bar, BarLine, Boxplot, Bullet, Cleveland, DotLine … (19 types; see CXGraphTypeKeys)
@@ -7229,6 +7406,13 @@ export interface CXConfig {
7229
7406
  * @default false
7230
7407
  */
7231
7408
  showLoessFit?: string | boolean;
7409
+ /**
7410
+ * Flag to show/hide the region labels on maps (only labels that fit inside their region
7411
+ * without overlapping another label are drawn, largest regions first)
7412
+ * @graphTypes Map
7413
+ * @default false
7414
+ */
7415
+ showMapLabels?: boolean;
7232
7416
  /**
7233
7417
  * Flag to show/hide the the overlays name
7234
7418
  * @graphTypes Bar, BarLine, Boxplot, Bullet, Cleveland, DotLine … (19 types; see CXGraphTypeKeys)
@@ -7790,6 +7974,18 @@ export interface CXConfig {
7790
7974
  * @default false
7791
7975
  */
7792
7976
  sortOnGrouping?: string | boolean;
7977
+ /**
7978
+ * Data source name shown in the chart footer as "Source: ...". Combine with sourceUrl to
7979
+ * make it a link
7980
+ * @default false
7981
+ */
7982
+ source?: string | boolean;
7983
+ /**
7984
+ * URL for the footer data source. When set with source, the "Source: ..." footer text
7985
+ * becomes a clickable link (exports still include the text)
7986
+ * @default false
7987
+ */
7988
+ sourceUrl?: string | boolean;
7793
7989
  /**
7794
7990
  * Factor (in the x data object) used to split the samples ala split in a complex heatmap.
7795
7991
  * Unlike segregateSamplesBy, the split keeps a single full-width plot and only inserts a
@@ -8215,6 +8411,15 @@ export interface CXConfig {
8215
8411
  * @default false
8216
8412
  */
8217
8413
  tooltipFontColor?: string | boolean;
8414
+ /**
8415
+ * Number format for values displayed in tooltips. Overrides numberFormat. It could be a
8416
+ * preset name (comma, percent, dollar, euro, pound, yen, compact), a sprintf format string,
8417
+ * or an object, i.e. {"locale": "en-US", "style": "decimal|percent|currency|compact",
8418
+ * "currency": "USD", "decimals": 1, "grouping": true, "prefix": "", "suffix": ""}. Uses
8419
+ * Intl.NumberFormat when available
8420
+ * @default false
8421
+ */
8422
+ tooltipNumberFormat?: string | Record<string, unknown> | boolean;
8218
8423
  /**
8219
8424
  * Transparency for the tooltip
8220
8425
  * @default null
@@ -9145,6 +9350,17 @@ export interface CXConfig {
9145
9350
  * @default []
9146
9351
  */
9147
9352
  xAxis2?: unknown[] | boolean | string | number;
9353
+ /**
9354
+ * Locale-aware number format for the tick values in the second X axis. Overrides
9355
+ * numberFormat for this axis; an explicit xAxis2TickFormat takes precedence over it. It
9356
+ * could be a preset name (comma, percent, dollar, euro, pound, yen, compact), a sprintf
9357
+ * format string, or an object, i.e. {"locale": "en-US", "style":
9358
+ * "decimal|percent|currency|compact", "currency": "USD", "decimals": 1, "grouping": true,
9359
+ * "prefix": "", "suffix": ""}
9360
+ * @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
9361
+ * @default false
9362
+ */
9363
+ xAxis2NumberFormat?: string | Record<string, unknown> | boolean;
9148
9364
  /**
9149
9365
  * Flag to rotate 180 degrees the direction of the X axis on the top
9150
9366
  * @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
@@ -9383,6 +9599,16 @@ export interface CXConfig {
9383
9599
  * @default 2
9384
9600
  */
9385
9601
  xAxisMinorTicks?: number | boolean;
9602
+ /**
9603
+ * Locale-aware number format for the tick values in the X axis. Overrides numberFormat for
9604
+ * this axis; an explicit xAxisTickFormat takes precedence over it. It could be a preset name
9605
+ * (comma, percent, dollar, euro, pound, yen, compact), a sprintf format string, or an
9606
+ * object, i.e. {"locale": "en-US", "style": "decimal|percent|currency|compact", "currency":
9607
+ * "USD", "decimals": 1, "grouping": true, "prefix": "", "suffix": ""}
9608
+ * @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
9609
+ * @default false
9610
+ */
9611
+ xAxisNumberFormat?: string | Record<string, unknown> | boolean;
9386
9612
  /**
9387
9613
  * Size in pixels for the data rug in the X axis
9388
9614
  * @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
@@ -9853,6 +10079,16 @@ export interface CXConfig {
9853
10079
  * @default 2
9854
10080
  */
9855
10081
  yAxisMinorTicks?: number | boolean;
10082
+ /**
10083
+ * Locale-aware number format for the tick values in the Y axis. Overrides numberFormat for
10084
+ * this axis; an explicit yAxisTickFormat takes precedence over it. It could be a preset name
10085
+ * (comma, percent, dollar, euro, pound, yen, compact), a sprintf format string, or an
10086
+ * object, i.e. {"locale": "en-US", "style": "decimal|percent|currency|compact", "currency":
10087
+ * "USD", "decimals": 1, "grouping": true, "prefix": "", "suffix": ""}
10088
+ * @graphTypes Bin, Binplot, CDF, Contour, Density, Distribution … (21 types; see CXGraphTypeKeys)
10089
+ * @default false
10090
+ */
10091
+ yAxisNumberFormat?: string | Record<string, unknown> | boolean;
9856
10092
  /**
9857
10093
  * Size in pixels for the data rug in the Y axis
9858
10094
  * @graphTypes Bin, Binplot, CDF, Contour, Density, Distribution … (21 types; see CXGraphTypeKeys)
@@ -10242,6 +10478,16 @@ export interface CXConfig {
10242
10478
  * @default 1
10243
10479
  */
10244
10480
  zAxisLogTicksWidth?: number | boolean;
10481
+ /**
10482
+ * Locale-aware number format for the tick values in the Z axis. Overrides numberFormat for
10483
+ * this axis; an explicit zAxisTickFormat takes precedence over it. It could be a preset name
10484
+ * (comma, percent, dollar, euro, pound, yen, compact), a sprintf format string, or an
10485
+ * object, i.e. {"locale": "en-US", "style": "decimal|percent|currency|compact", "currency":
10486
+ * "USD", "decimals": 1, "grouping": true, "prefix": "", "suffix": ""}
10487
+ * @graphTypes ScatterBubble2D, Scatter3D
10488
+ * @default false
10489
+ */
10490
+ zAxisNumberFormat?: string | Record<string, unknown> | boolean;
10245
10491
  /**
10246
10492
  * Set the tick labels paired one-to-one with zAxisSetValues in the Z axis
10247
10493
  * @graphTypes ScatterBubble2D, Scatter3D
@@ -10640,6 +10886,7 @@ export type CXKeysCircularGraphs =
10640
10886
  | "circularType";
10641
10887
  /** Config keys in the "Citations or References" category. */
10642
10888
  export type CXKeysCitationsorReferences =
10889
+ | "byline"
10643
10890
  | "citation"
10644
10891
  | "citationAlign"
10645
10892
  | "citationBaseline"
@@ -10648,7 +10895,12 @@ export type CXKeysCitationsorReferences =
10648
10895
  | "citationFontStyle"
10649
10896
  | "citationMargin"
10650
10897
  | "citationRotate"
10651
- | "citationScaleFontFactor";
10898
+ | "citationScaleFontFactor"
10899
+ | "footerAlign"
10900
+ | "notes"
10901
+ | "showDataDownload"
10902
+ | "source"
10903
+ | "sourceUrl";
10652
10904
  /** Config keys in the "Clustering" category. */
10653
10905
  export type CXKeysClustering =
10654
10906
  | "clusterAxis"
@@ -10665,10 +10917,12 @@ export type CXKeysClustering =
10665
10917
  /** Config keys in the "Colors" category. */
10666
10918
  export type CXKeysColors =
10667
10919
  | "blindnessType"
10920
+ | "colorLegendSteps"
10668
10921
  | "colorScheme"
10669
10922
  | "colorSpectrum"
10670
10923
  | "colorSpectrumBinned"
10671
10924
  | "colorSpectrumBreaks"
10925
+ | "colorSpectrumBreaksMethod"
10672
10926
  | "colorSpectrumByFactor"
10673
10927
  | "colorSpectrumByObject"
10674
10928
  | "colorSpectrumZeroValue"
@@ -10920,11 +11174,15 @@ export type CXKeysDataTable =
10920
11174
  | "dataTableColOrder"
10921
11175
  | "dataTableColPin"
10922
11176
  | "dataTableColProperties"
11177
+ | "dataTableColRenderer"
10923
11178
  | "dataTableColWidth"
10924
11179
  | "dataTableColorTransparency"
10925
11180
  | "dataTableColored"
11181
+ | "dataTableFitHeight"
11182
+ | "dataTableFitWidth"
10926
11183
  | "dataTableGrouped"
10927
11184
  | "dataTableHeaderBackgroundColor"
11185
+ | "dataTableHeaderIcons"
10928
11186
  | "dataTableHeaderTemplate"
10929
11187
  | "dataTableHeaderTextAlign"
10930
11188
  | "dataTableHeaderTextBaseline"
@@ -11079,6 +11337,7 @@ export type CXKeysDotplotGraphs =
11079
11337
  | "dotplotType";
11080
11338
  /** Config keys in the "Dumbbell Graphs" category. */
11081
11339
  export type CXKeysDumbbellGraphs =
11340
+ | "dumbbellArrowDirection"
11082
11341
  | "dumbbellType";
11083
11342
  /** Config keys in the "Error Bars" category. */
11084
11343
  export type CXKeysErrorBars =
@@ -11426,6 +11685,7 @@ export type CXKeysLegends =
11426
11685
  | "legendDirection"
11427
11686
  | "legendHorizontalJustification"
11428
11687
  | "legendInside"
11688
+ | "legendJustifyTo"
11429
11689
  | "legendKeyBackgroundBorderColor"
11430
11690
  | "legendKeyBackgroundBorderLineType"
11431
11691
  | "legendKeyBackgroundBorderSize"
@@ -11482,6 +11742,7 @@ export type CXKeysLineGraphs =
11482
11742
  | "lineDecoration"
11483
11743
  | "lineErrorType"
11484
11744
  | "lineType"
11745
+ | "showLineEndLabels"
11485
11746
  | "tension"
11486
11747
  | "tensionSegments";
11487
11748
  /** Config keys in the "Lines" category. */
@@ -11530,16 +11791,20 @@ export type CXKeysManhattanPlots =
11530
11791
  /** Config keys in the "Maps" category. */
11531
11792
  export type CXKeysMaps =
11532
11793
  | "hiddenMapFeatures"
11794
+ | "mapBubbleColor"
11533
11795
  | "mapColor"
11534
11796
  | "mapConfig"
11535
11797
  | "mapConfigFeatures"
11536
11798
  | "mapId"
11799
+ | "mapLabelColor"
11800
+ | "mapLabelProperty"
11537
11801
  | "mapMarkerShape"
11538
11802
  | "mapMarkerShapeScaleFactor"
11539
11803
  | "mapOutlineColor"
11540
11804
  | "mapProjection"
11541
11805
  | "mapSmps"
11542
11806
  | "mapZipCodeIds"
11807
+ | "showMapLabels"
11543
11808
  | "topoJSON"
11544
11809
  | "visibleMapFeatures";
11545
11810
  /** Config keys in the "Maps Albers" category. */
@@ -11772,6 +12037,7 @@ export type CXKeysPieCharts =
11772
12037
  | "pieSegmentLabels"
11773
12038
  | "pieSegmentPrecision"
11774
12039
  | "pieSegmentSeparation"
12040
+ | "pieShape"
11775
12041
  | "pieType"
11776
12042
  | "showPieSampleLabel"
11777
12043
  | "showPieValues"
@@ -11782,6 +12048,7 @@ export type CXKeysPlotArea =
11782
12048
  | "binned"
11783
12049
  | "blockContrast"
11784
12050
  | "dataValuesFrequency"
12051
+ | "dataValuesHideOverlap"
11785
12052
  | "dataValuesPosition"
11786
12053
  | "dotplotOutlineThreshold"
11787
12054
  | "guideStyle"
@@ -11807,7 +12074,8 @@ export type CXKeysPlotDataType =
11807
12074
  | "isCxplot"
11808
12075
  | "isDataFrame"
11809
12076
  | "isGGMatrix"
11810
- | "isR";
12077
+ | "isR"
12078
+ | "responsiveRules";
11811
12079
  /** Config keys in the "Plot Mode" category. */
11812
12080
  export type CXKeysPlotMode =
11813
12081
  | "isEditable"
@@ -11874,6 +12142,7 @@ export type CXKeysRAxis =
11874
12142
  | "rAxisLogTicksShow"
11875
12143
  | "rAxisLogTicksTransparency"
11876
12144
  | "rAxisLogTicksWidth"
12145
+ | "rAxisNumberFormat"
11877
12146
  | "rAxisPercentShow"
11878
12147
  | "rAxisSetLabels"
11879
12148
  | "rAxisSetMinorValues"
@@ -12078,6 +12347,7 @@ export type CXKeysText =
12078
12347
  | "align"
12079
12348
  | "autoScaleFont"
12080
12349
  | "baseline"
12350
+ | "dataLabelNumberFormat"
12081
12351
  | "fontColor"
12082
12352
  | "fontName"
12083
12353
  | "fontScaleFontFactor"
@@ -12085,8 +12355,11 @@ export type CXKeysText =
12085
12355
  | "fontStyle"
12086
12356
  | "fonts"
12087
12357
  | "fontsExternal"
12358
+ | "legendNumberFormat"
12088
12359
  | "maxTextSize"
12089
- | "minTextSize";
12360
+ | "minTextSize"
12361
+ | "numberFormat"
12362
+ | "tooltipNumberFormat";
12090
12363
  /** Config keys in the "Text Placement" category. */
12091
12364
  export type CXKeysTextPlacement =
12092
12365
  | "optimizeTextPosition"
@@ -12096,6 +12369,7 @@ export type CXKeysTextPlacement =
12096
12369
  | "optimizeTextPositionTemperature";
12097
12370
  /** Config keys in the "Titles and Subtitles" category. */
12098
12371
  export type CXKeysTitlesandSubtitles =
12372
+ | "a11yDescription"
12099
12373
  | "subtitle"
12100
12374
  | "subtitleAlign"
12101
12375
  | "subtitleBaseline"
@@ -12247,6 +12521,7 @@ export type CXKeysXAxis =
12247
12521
  | "setPanningMinX"
12248
12522
  | "xAxis"
12249
12523
  | "xAxis2"
12524
+ | "xAxis2NumberFormat"
12250
12525
  | "xAxis2Rotate"
12251
12526
  | "xAxis2Show"
12252
12527
  | "xAxis2TickFormat"
@@ -12286,6 +12561,7 @@ export type CXKeysXAxis =
12286
12561
  | "xAxisLogTicksTransparency"
12287
12562
  | "xAxisLogTicksWidth"
12288
12563
  | "xAxisMinorTicks"
12564
+ | "xAxisNumberFormat"
12289
12565
  | "xAxisRugHeight"
12290
12566
  | "xAxisRugPosition"
12291
12567
  | "xAxisRugShow"
@@ -12367,6 +12643,7 @@ export type CXKeysYAxis =
12367
12643
  | "yAxisLogTicksTransparency"
12368
12644
  | "yAxisLogTicksWidth"
12369
12645
  | "yAxisMinorTicks"
12646
+ | "yAxisNumberFormat"
12370
12647
  | "yAxisRugHeight"
12371
12648
  | "yAxisRugPosition"
12372
12649
  | "yAxisRugShow"
@@ -12431,6 +12708,7 @@ export type CXKeysZAxis =
12431
12708
  | "zAxisLogTicksShow"
12432
12709
  | "zAxisLogTicksTransparency"
12433
12710
  | "zAxisLogTicksWidth"
12711
+ | "zAxisNumberFormat"
12434
12712
  | "zAxisSetLabels"
12435
12713
  | "zAxisSetMinorValues"
12436
12714
  | "zAxisSetValues"