canvasxpress 70.7.0 → 70.8.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 +21 -2
- package/src/canvasXpress.d.mts +270 -9
- package/src/canvasXpress.d.ts +270 -9
- package/src/canvasXpress.js +3 -3
package/package.json
CHANGED
package/src/canvasXpress.css
CHANGED
|
@@ -505,7 +505,7 @@ div.cX-Toolbar-Help {
|
|
|
505
505
|
--cx-ui-border: var(--cx-color-gray-700) !important;
|
|
506
506
|
--cx-ui-border-subtle: var(--cx-color-gray-800) !important;
|
|
507
507
|
--cx-ui-divider: var(--cx-color-gray-800) !important;
|
|
508
|
-
--cx-ui-border-accent: var(--cx-ui-dark-accent, var(--cx-color-indigo-400)) !important;
|
|
508
|
+
--cx-ui-border-accent: var(--cx-ui-dark-border-accent, var(--cx-color-indigo-400)) !important;
|
|
509
509
|
--cx-ui-accent: var(--cx-ui-dark-accent, var(--cx-color-indigo-400)) !important;
|
|
510
510
|
--cx-ui-accent-strong: var(--cx-ui-dark-accent-strong, var(--cx-color-indigo-300)) !important;
|
|
511
511
|
--cx-ui-accent-hover: var(--cx-ui-dark-accent, var(--cx-color-indigo-400)) !important;
|
|
@@ -556,7 +556,7 @@ div.cX-Toolbar-Help {
|
|
|
556
556
|
--cx-ui-border: var(--cx-color-gray-700) !important;
|
|
557
557
|
--cx-ui-border-subtle: var(--cx-color-gray-800) !important;
|
|
558
558
|
--cx-ui-divider: var(--cx-color-gray-800) !important;
|
|
559
|
-
--cx-ui-border-accent: var(--cx-ui-dark-accent, var(--cx-color-indigo-400)) !important;
|
|
559
|
+
--cx-ui-border-accent: var(--cx-ui-dark-border-accent, var(--cx-color-indigo-400)) !important;
|
|
560
560
|
--cx-ui-accent: var(--cx-ui-dark-accent, var(--cx-color-indigo-400)) !important;
|
|
561
561
|
--cx-ui-accent-strong: var(--cx-ui-dark-accent-strong, var(--cx-color-indigo-300)) !important;
|
|
562
562
|
--cx-ui-accent-hover: var(--cx-ui-dark-accent, var(--cx-color-indigo-400)) !important;
|
|
@@ -5176,6 +5176,25 @@ table.cX-DataTable,
|
|
|
5176
5176
|
height: 30%;
|
|
5177
5177
|
}
|
|
5178
5178
|
|
|
5179
|
+
/* dataTableHeaderIcons "hover" (auto with the minimal dataUIStyle): the header menu, filter and
|
|
5180
|
+
resize handle appear while the header cell is hovered or has keyboard focus. Opacity, not
|
|
5181
|
+
display, so the resize handle stays grabbable; sorting and an active filter stay visible. */
|
|
5182
|
+
.cX-DataTable-HeaderIconsHover .cX-DataTable-Cell-Header-Menu,
|
|
5183
|
+
.cX-DataTable-HeaderIconsHover .cX-DataTable-Cell-Header-Filter:not(.cX-DataTable-Cell-Header-Filter-Active),
|
|
5184
|
+
.cX-DataTable-HeaderIconsHover .cX-DataTable-Cell-Header-Resize {
|
|
5185
|
+
opacity: 0;
|
|
5186
|
+
transition: opacity 0.15s;
|
|
5187
|
+
}
|
|
5188
|
+
|
|
5189
|
+
.cX-DataTable-HeaderIconsHover :is(td, th):hover .cX-DataTable-Cell-Header-Menu,
|
|
5190
|
+
.cX-DataTable-HeaderIconsHover :is(td, th):hover .cX-DataTable-Cell-Header-Filter,
|
|
5191
|
+
.cX-DataTable-HeaderIconsHover :is(td, th):hover .cX-DataTable-Cell-Header-Resize,
|
|
5192
|
+
.cX-DataTable-HeaderIconsHover :is(td, th):focus-within .cX-DataTable-Cell-Header-Menu,
|
|
5193
|
+
.cX-DataTable-HeaderIconsHover :is(td, th):focus-within .cX-DataTable-Cell-Header-Filter,
|
|
5194
|
+
.cX-DataTable-HeaderIconsHover :is(td, th):focus-within .cX-DataTable-Cell-Header-Resize {
|
|
5195
|
+
opacity: 1;
|
|
5196
|
+
}
|
|
5197
|
+
|
|
5179
5198
|
.cX-DataTable-Cell-Head-Text {
|
|
5180
5199
|
color: var(--cx-datatable-header-text-color, var(--cx-ui-text))
|
|
5181
5200
|
}
|
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 (1732 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)
|
|
@@ -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
|
|
1616
|
-
* string
|
|
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,7 +2097,7 @@ 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)
|
|
@@ -2373,6 +2437,13 @@ export interface CXConfig {
|
|
|
2373
2437
|
* @default "normal"
|
|
2374
2438
|
*/
|
|
2375
2439
|
dotplotType?: "arrow" | "bullet" | "cleveland" | "connected" | "line" | "lineConnected" | "normal" | "stacked" | "transition" | false | (string & {});
|
|
2440
|
+
/**
|
|
2441
|
+
* Direction of the arrows in arrow dumbbells (dumbbellType arrow): value points each arrow
|
|
2442
|
+
* at the smaller value; order points from the first variable to the next (before to after)
|
|
2443
|
+
* @graphTypes Boxplot, Cleveland, DotLine, Dotplot, Dumbbell, Violin
|
|
2444
|
+
* @default "value"
|
|
2445
|
+
*/
|
|
2446
|
+
dumbbellArrowDirection?: "value" | "order" | false | (string & {});
|
|
2376
2447
|
/**
|
|
2377
2448
|
* Style for the dumbbell plot
|
|
2378
2449
|
* @graphTypes Boxplot, Cleveland, DotLine, Dotplot, Dumbbell, Violin
|
|
@@ -2779,6 +2850,12 @@ export interface CXConfig {
|
|
|
2779
2850
|
* @default []
|
|
2780
2851
|
*/
|
|
2781
2852
|
fontsExternal?: unknown[] | boolean | string | number;
|
|
2853
|
+
/**
|
|
2854
|
+
* Horizontal alignment for the structured chart footer (notes, source, byline, data
|
|
2855
|
+
* download)
|
|
2856
|
+
* @default "left"
|
|
2857
|
+
*/
|
|
2858
|
+
footerAlign?: "left" | "center" | "right" | false | (string & {});
|
|
2782
2859
|
/**
|
|
2783
2860
|
* Number of future steps to forecast. 0 uses the forecast package default: 10, or two
|
|
2784
2861
|
* seasons when forecastSeasonLength is greater than 1
|
|
@@ -3942,6 +4019,15 @@ export interface CXConfig {
|
|
|
3942
4019
|
* @default 50
|
|
3943
4020
|
*/
|
|
3944
4021
|
legendMax?: number | boolean;
|
|
4022
|
+
/**
|
|
4023
|
+
* Number format for numeric values displayed in legends (continuous color ramps and size-by
|
|
4024
|
+
* bins). Overrides numberFormat. It could be a preset name (comma, percent, dollar, euro,
|
|
4025
|
+
* pound, yen, compact), a sprintf format string, or an object, i.e. {"locale": "en-US",
|
|
4026
|
+
* "style": "decimal|percent|currency|compact", "currency": "USD", "decimals": 1, "grouping":
|
|
4027
|
+
* true, "prefix": "", "suffix": ""}. Uses Intl.NumberFormat when available
|
|
4028
|
+
* @default false
|
|
4029
|
+
*/
|
|
4030
|
+
legendNumberFormat?: string | Record<string, unknown> | boolean;
|
|
3945
4031
|
/**
|
|
3946
4032
|
* Object to specify custom order for the levels in the legends. The key of the object is the
|
|
3947
4033
|
* name of a valid sample or variable annotation included in the data object. The value for
|
|
@@ -4334,6 +4420,13 @@ export interface CXConfig {
|
|
|
4334
4420
|
* @default false
|
|
4335
4421
|
*/
|
|
4336
4422
|
manhattanRangeStart?: string | boolean;
|
|
4423
|
+
/**
|
|
4424
|
+
* Color for the region bubbles on maps (sizeBy a sample: a circle per region sized by its
|
|
4425
|
+
* value); the size legend uses it too
|
|
4426
|
+
* @graphTypes Map
|
|
4427
|
+
* @default "rgba(255,0,0,0.6)"
|
|
4428
|
+
*/
|
|
4429
|
+
mapBubbleColor?: string | boolean;
|
|
4337
4430
|
/**
|
|
4338
4431
|
* Map Latitude Of Origin in degrees. (Applicable to Albers projection only). Default adjusts
|
|
4339
4432
|
* to USA maps
|
|
@@ -4377,6 +4470,20 @@ export interface CXConfig {
|
|
|
4377
4470
|
* @default false
|
|
4378
4471
|
*/
|
|
4379
4472
|
mapId?: string | boolean;
|
|
4473
|
+
/**
|
|
4474
|
+
* Color for the region labels on maps. Defaults to black or white, whichever contrasts with
|
|
4475
|
+
* the region fill
|
|
4476
|
+
* @graphTypes Map
|
|
4477
|
+
* @default false
|
|
4478
|
+
*/
|
|
4479
|
+
mapLabelColor?: string | boolean;
|
|
4480
|
+
/**
|
|
4481
|
+
* Map feature property used as the region label (defaults to name, then NAME, then the
|
|
4482
|
+
* region key)
|
|
4483
|
+
* @graphTypes Map
|
|
4484
|
+
* @default false
|
|
4485
|
+
*/
|
|
4486
|
+
mapLabelProperty?: string | boolean;
|
|
4380
4487
|
/**
|
|
4381
4488
|
* Map Latitude Of Origin in degrees. (Applicable to Albers projection only). Default adjusts
|
|
4382
4489
|
* to USA maps
|
|
@@ -4962,6 +5069,21 @@ export interface CXConfig {
|
|
|
4962
5069
|
* @default 1
|
|
4963
5070
|
*/
|
|
4964
5071
|
nodeSizeScaleFactor?: number | boolean;
|
|
5072
|
+
/**
|
|
5073
|
+
* Footer notes drawn above the source line at the bottom of the chart. Newlines split into
|
|
5074
|
+
* multiple lines
|
|
5075
|
+
* @default false
|
|
5076
|
+
*/
|
|
5077
|
+
notes?: string | boolean;
|
|
5078
|
+
/**
|
|
5079
|
+
* Default number format for values displayed in axis ticks, tooltips, legends and data
|
|
5080
|
+
* labels. It could be a preset name (comma, percent, dollar, euro, pound, yen, compact), a
|
|
5081
|
+
* sprintf format string, or an object, i.e. {"locale": "en-US", "style":
|
|
5082
|
+
* "decimal|percent|currency|compact", "currency": "USD", "decimals": 1, "grouping": true,
|
|
5083
|
+
* "prefix": "", "suffix": ""}. Uses Intl.NumberFormat when available
|
|
5084
|
+
* @default false
|
|
5085
|
+
*/
|
|
5086
|
+
numberFormat?: string | Record<string, unknown> | boolean;
|
|
4965
5087
|
/**
|
|
4966
5088
|
* Sort group keys numerically (type-aware: plain integers, range labels, composite keys)
|
|
4967
5089
|
* instead of lexicographically
|
|
@@ -5432,11 +5554,19 @@ export interface CXConfig {
|
|
|
5432
5554
|
*/
|
|
5433
5555
|
pieSegmentSeparation?: number | boolean;
|
|
5434
5556
|
/**
|
|
5435
|
-
*
|
|
5557
|
+
* Shape of the pie: a full circle, or a half circle (semicircle, e.g. an election donut with
|
|
5558
|
+
* pieInnerRadius)
|
|
5559
|
+
* @graphTypes Pie
|
|
5560
|
+
* @default "full"
|
|
5561
|
+
*/
|
|
5562
|
+
pieShape?: "full" | "half" | false | (string & {});
|
|
5563
|
+
/**
|
|
5564
|
+
* Position for the pices of the pie. parliament draws one dot per seat on a hemicycle (the
|
|
5565
|
+
* values are seat counts), grouped by party from left to right
|
|
5436
5566
|
* @graphTypes Pie
|
|
5437
5567
|
* @default "separated"
|
|
5438
5568
|
*/
|
|
5439
|
-
pieType?: "separated" | "solid" | false | (string & {});
|
|
5569
|
+
pieType?: "separated" | "solid" | "parliament" | false | (string & {});
|
|
5440
5570
|
/**
|
|
5441
5571
|
* Utility to pivot data with a sample annotation
|
|
5442
5572
|
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
@@ -5664,6 +5794,16 @@ export interface CXConfig {
|
|
|
5664
5794
|
* @default 1
|
|
5665
5795
|
*/
|
|
5666
5796
|
rAxisLogTicksWidth?: number | boolean;
|
|
5797
|
+
/**
|
|
5798
|
+
* Locale-aware number format for the tick values in the R axis. Overrides numberFormat for
|
|
5799
|
+
* this axis; an explicit rAxisTickFormat takes precedence over it. It could be a preset name
|
|
5800
|
+
* (comma, percent, dollar, euro, pound, yen, compact), a sprintf format string, or an
|
|
5801
|
+
* object, i.e. {"locale": "en-US", "style": "decimal|percent|currency|compact", "currency":
|
|
5802
|
+
* "USD", "decimals": 1, "grouping": true, "prefix": "", "suffix": ""}
|
|
5803
|
+
* @graphTypes Circular
|
|
5804
|
+
* @default false
|
|
5805
|
+
*/
|
|
5806
|
+
rAxisNumberFormat?: string | Record<string, unknown> | boolean;
|
|
5667
5807
|
/**
|
|
5668
5808
|
* Flag to show on not the percent in each segment in the R axis
|
|
5669
5809
|
* @graphTypes Circular
|
|
@@ -6003,6 +6143,15 @@ export interface CXConfig {
|
|
|
6003
6143
|
* @default true
|
|
6004
6144
|
*/
|
|
6005
6145
|
resizableY?: boolean;
|
|
6146
|
+
/**
|
|
6147
|
+
* Width-based config overrides applied on render/resize, i.e. [{"maxWidth": 480, "config":
|
|
6148
|
+
* {"legendPosition": "bottom", "fontScaleFontFactor": 0.8}}]. A rule matches when the canvas
|
|
6149
|
+
* width is <= maxWidth and >= minWidth (either bound optional); later rules win on
|
|
6150
|
+
* conflicting keys. Overrides revert automatically when the width stops matching and are
|
|
6151
|
+
* never saved into the configuration
|
|
6152
|
+
* @default []
|
|
6153
|
+
*/
|
|
6154
|
+
responsiveRules?: unknown[] | boolean | string | number;
|
|
6006
6155
|
/**
|
|
6007
6156
|
* Name of a sample annotation(s) to create a ribbon of each variable in scatter plots. If a
|
|
6008
6157
|
* single annotation is passed then it will be used as a standard deviation. If two
|
|
@@ -7049,6 +7198,12 @@ export interface CXConfig {
|
|
|
7049
7198
|
* @default false
|
|
7050
7199
|
*/
|
|
7051
7200
|
showContourLevel?: boolean;
|
|
7201
|
+
/**
|
|
7202
|
+
* Flag to show a "Get the data" link in the chart footer which downloads the current data as
|
|
7203
|
+
* CSV
|
|
7204
|
+
* @default false
|
|
7205
|
+
*/
|
|
7206
|
+
showDataDownload?: boolean;
|
|
7052
7207
|
/**
|
|
7053
7208
|
* Flag to show/hide the data labels in scatter plots
|
|
7054
7209
|
* @graphTypes Bin, Binplot, Bump, CDF, Contour, Density … (22 types; see CXGraphTypeKeys)
|
|
@@ -7216,6 +7371,13 @@ export interface CXConfig {
|
|
|
7216
7371
|
* @default true
|
|
7217
7372
|
*/
|
|
7218
7373
|
showLineEdgeLegend?: boolean;
|
|
7374
|
+
/**
|
|
7375
|
+
* Flag to show/hide the series name at the end of each line in line graphs, in the series
|
|
7376
|
+
* color, replacing the legend (direct labeling). Overlapping labels are nudged apart
|
|
7377
|
+
* @graphTypes Area, AreaLine, BarLine, DotLine, Line, ParallelCoordinates … (9 types; see CXGraphTypeKeys)
|
|
7378
|
+
* @default false
|
|
7379
|
+
*/
|
|
7380
|
+
showLineEndLabels?: boolean;
|
|
7219
7381
|
/**
|
|
7220
7382
|
* Flag to show/hide the legend line
|
|
7221
7383
|
* @graphTypes Bar, BarLine, Boxplot, Bullet, Cleveland, DotLine … (19 types; see CXGraphTypeKeys)
|
|
@@ -7229,6 +7391,13 @@ export interface CXConfig {
|
|
|
7229
7391
|
* @default false
|
|
7230
7392
|
*/
|
|
7231
7393
|
showLoessFit?: string | boolean;
|
|
7394
|
+
/**
|
|
7395
|
+
* Flag to show/hide the region labels on maps (only labels that fit inside their region
|
|
7396
|
+
* without overlapping another label are drawn, largest regions first)
|
|
7397
|
+
* @graphTypes Map
|
|
7398
|
+
* @default false
|
|
7399
|
+
*/
|
|
7400
|
+
showMapLabels?: boolean;
|
|
7232
7401
|
/**
|
|
7233
7402
|
* Flag to show/hide the the overlays name
|
|
7234
7403
|
* @graphTypes Bar, BarLine, Boxplot, Bullet, Cleveland, DotLine … (19 types; see CXGraphTypeKeys)
|
|
@@ -7790,6 +7959,18 @@ export interface CXConfig {
|
|
|
7790
7959
|
* @default false
|
|
7791
7960
|
*/
|
|
7792
7961
|
sortOnGrouping?: string | boolean;
|
|
7962
|
+
/**
|
|
7963
|
+
* Data source name shown in the chart footer as "Source: ...". Combine with sourceUrl to
|
|
7964
|
+
* make it a link
|
|
7965
|
+
* @default false
|
|
7966
|
+
*/
|
|
7967
|
+
source?: string | boolean;
|
|
7968
|
+
/**
|
|
7969
|
+
* URL for the footer data source. When set with source, the "Source: ..." footer text
|
|
7970
|
+
* becomes a clickable link (exports still include the text)
|
|
7971
|
+
* @default false
|
|
7972
|
+
*/
|
|
7973
|
+
sourceUrl?: string | boolean;
|
|
7793
7974
|
/**
|
|
7794
7975
|
* Factor (in the x data object) used to split the samples ala split in a complex heatmap.
|
|
7795
7976
|
* Unlike segregateSamplesBy, the split keeps a single full-width plot and only inserts a
|
|
@@ -8215,6 +8396,15 @@ export interface CXConfig {
|
|
|
8215
8396
|
* @default false
|
|
8216
8397
|
*/
|
|
8217
8398
|
tooltipFontColor?: string | boolean;
|
|
8399
|
+
/**
|
|
8400
|
+
* Number format for values displayed in tooltips. Overrides numberFormat. It could be a
|
|
8401
|
+
* preset name (comma, percent, dollar, euro, pound, yen, compact), a sprintf format string,
|
|
8402
|
+
* or an object, i.e. {"locale": "en-US", "style": "decimal|percent|currency|compact",
|
|
8403
|
+
* "currency": "USD", "decimals": 1, "grouping": true, "prefix": "", "suffix": ""}. Uses
|
|
8404
|
+
* Intl.NumberFormat when available
|
|
8405
|
+
* @default false
|
|
8406
|
+
*/
|
|
8407
|
+
tooltipNumberFormat?: string | Record<string, unknown> | boolean;
|
|
8218
8408
|
/**
|
|
8219
8409
|
* Transparency for the tooltip
|
|
8220
8410
|
* @default null
|
|
@@ -9145,6 +9335,17 @@ export interface CXConfig {
|
|
|
9145
9335
|
* @default []
|
|
9146
9336
|
*/
|
|
9147
9337
|
xAxis2?: unknown[] | boolean | string | number;
|
|
9338
|
+
/**
|
|
9339
|
+
* Locale-aware number format for the tick values in the second X axis. Overrides
|
|
9340
|
+
* numberFormat for this axis; an explicit xAxis2TickFormat takes precedence over it. It
|
|
9341
|
+
* could be a preset name (comma, percent, dollar, euro, pound, yen, compact), a sprintf
|
|
9342
|
+
* format string, or an object, i.e. {"locale": "en-US", "style":
|
|
9343
|
+
* "decimal|percent|currency|compact", "currency": "USD", "decimals": 1, "grouping": true,
|
|
9344
|
+
* "prefix": "", "suffix": ""}
|
|
9345
|
+
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
9346
|
+
* @default false
|
|
9347
|
+
*/
|
|
9348
|
+
xAxis2NumberFormat?: string | Record<string, unknown> | boolean;
|
|
9148
9349
|
/**
|
|
9149
9350
|
* Flag to rotate 180 degrees the direction of the X axis on the top
|
|
9150
9351
|
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
@@ -9383,6 +9584,16 @@ export interface CXConfig {
|
|
|
9383
9584
|
* @default 2
|
|
9384
9585
|
*/
|
|
9385
9586
|
xAxisMinorTicks?: number | boolean;
|
|
9587
|
+
/**
|
|
9588
|
+
* Locale-aware number format for the tick values in the X axis. Overrides numberFormat for
|
|
9589
|
+
* this axis; an explicit xAxisTickFormat takes precedence over it. It could be a preset name
|
|
9590
|
+
* (comma, percent, dollar, euro, pound, yen, compact), a sprintf format string, or an
|
|
9591
|
+
* object, i.e. {"locale": "en-US", "style": "decimal|percent|currency|compact", "currency":
|
|
9592
|
+
* "USD", "decimals": 1, "grouping": true, "prefix": "", "suffix": ""}
|
|
9593
|
+
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
9594
|
+
* @default false
|
|
9595
|
+
*/
|
|
9596
|
+
xAxisNumberFormat?: string | Record<string, unknown> | boolean;
|
|
9386
9597
|
/**
|
|
9387
9598
|
* Size in pixels for the data rug in the X axis
|
|
9388
9599
|
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
@@ -9853,6 +10064,16 @@ export interface CXConfig {
|
|
|
9853
10064
|
* @default 2
|
|
9854
10065
|
*/
|
|
9855
10066
|
yAxisMinorTicks?: number | boolean;
|
|
10067
|
+
/**
|
|
10068
|
+
* Locale-aware number format for the tick values in the Y axis. Overrides numberFormat for
|
|
10069
|
+
* this axis; an explicit yAxisTickFormat takes precedence over it. It could be a preset name
|
|
10070
|
+
* (comma, percent, dollar, euro, pound, yen, compact), a sprintf format string, or an
|
|
10071
|
+
* object, i.e. {"locale": "en-US", "style": "decimal|percent|currency|compact", "currency":
|
|
10072
|
+
* "USD", "decimals": 1, "grouping": true, "prefix": "", "suffix": ""}
|
|
10073
|
+
* @graphTypes Bin, Binplot, CDF, Contour, Density, Distribution … (21 types; see CXGraphTypeKeys)
|
|
10074
|
+
* @default false
|
|
10075
|
+
*/
|
|
10076
|
+
yAxisNumberFormat?: string | Record<string, unknown> | boolean;
|
|
9856
10077
|
/**
|
|
9857
10078
|
* Size in pixels for the data rug in the Y axis
|
|
9858
10079
|
* @graphTypes Bin, Binplot, CDF, Contour, Density, Distribution … (21 types; see CXGraphTypeKeys)
|
|
@@ -10242,6 +10463,16 @@ export interface CXConfig {
|
|
|
10242
10463
|
* @default 1
|
|
10243
10464
|
*/
|
|
10244
10465
|
zAxisLogTicksWidth?: number | boolean;
|
|
10466
|
+
/**
|
|
10467
|
+
* Locale-aware number format for the tick values in the Z axis. Overrides numberFormat for
|
|
10468
|
+
* this axis; an explicit zAxisTickFormat takes precedence over it. It could be a preset name
|
|
10469
|
+
* (comma, percent, dollar, euro, pound, yen, compact), a sprintf format string, or an
|
|
10470
|
+
* object, i.e. {"locale": "en-US", "style": "decimal|percent|currency|compact", "currency":
|
|
10471
|
+
* "USD", "decimals": 1, "grouping": true, "prefix": "", "suffix": ""}
|
|
10472
|
+
* @graphTypes ScatterBubble2D, Scatter3D
|
|
10473
|
+
* @default false
|
|
10474
|
+
*/
|
|
10475
|
+
zAxisNumberFormat?: string | Record<string, unknown> | boolean;
|
|
10245
10476
|
/**
|
|
10246
10477
|
* Set the tick labels paired one-to-one with zAxisSetValues in the Z axis
|
|
10247
10478
|
* @graphTypes ScatterBubble2D, Scatter3D
|
|
@@ -10640,6 +10871,7 @@ export type CXKeysCircularGraphs =
|
|
|
10640
10871
|
| "circularType";
|
|
10641
10872
|
/** Config keys in the "Citations or References" category. */
|
|
10642
10873
|
export type CXKeysCitationsorReferences =
|
|
10874
|
+
| "byline"
|
|
10643
10875
|
| "citation"
|
|
10644
10876
|
| "citationAlign"
|
|
10645
10877
|
| "citationBaseline"
|
|
@@ -10648,7 +10880,12 @@ export type CXKeysCitationsorReferences =
|
|
|
10648
10880
|
| "citationFontStyle"
|
|
10649
10881
|
| "citationMargin"
|
|
10650
10882
|
| "citationRotate"
|
|
10651
|
-
| "citationScaleFontFactor"
|
|
10883
|
+
| "citationScaleFontFactor"
|
|
10884
|
+
| "footerAlign"
|
|
10885
|
+
| "notes"
|
|
10886
|
+
| "showDataDownload"
|
|
10887
|
+
| "source"
|
|
10888
|
+
| "sourceUrl";
|
|
10652
10889
|
/** Config keys in the "Clustering" category. */
|
|
10653
10890
|
export type CXKeysClustering =
|
|
10654
10891
|
| "clusterAxis"
|
|
@@ -10665,10 +10902,12 @@ export type CXKeysClustering =
|
|
|
10665
10902
|
/** Config keys in the "Colors" category. */
|
|
10666
10903
|
export type CXKeysColors =
|
|
10667
10904
|
| "blindnessType"
|
|
10905
|
+
| "colorLegendSteps"
|
|
10668
10906
|
| "colorScheme"
|
|
10669
10907
|
| "colorSpectrum"
|
|
10670
10908
|
| "colorSpectrumBinned"
|
|
10671
10909
|
| "colorSpectrumBreaks"
|
|
10910
|
+
| "colorSpectrumBreaksMethod"
|
|
10672
10911
|
| "colorSpectrumByFactor"
|
|
10673
10912
|
| "colorSpectrumByObject"
|
|
10674
10913
|
| "colorSpectrumZeroValue"
|
|
@@ -10920,11 +11159,15 @@ export type CXKeysDataTable =
|
|
|
10920
11159
|
| "dataTableColOrder"
|
|
10921
11160
|
| "dataTableColPin"
|
|
10922
11161
|
| "dataTableColProperties"
|
|
11162
|
+
| "dataTableColRenderer"
|
|
10923
11163
|
| "dataTableColWidth"
|
|
10924
11164
|
| "dataTableColorTransparency"
|
|
10925
11165
|
| "dataTableColored"
|
|
11166
|
+
| "dataTableFitHeight"
|
|
11167
|
+
| "dataTableFitWidth"
|
|
10926
11168
|
| "dataTableGrouped"
|
|
10927
11169
|
| "dataTableHeaderBackgroundColor"
|
|
11170
|
+
| "dataTableHeaderIcons"
|
|
10928
11171
|
| "dataTableHeaderTemplate"
|
|
10929
11172
|
| "dataTableHeaderTextAlign"
|
|
10930
11173
|
| "dataTableHeaderTextBaseline"
|
|
@@ -11079,6 +11322,7 @@ export type CXKeysDotplotGraphs =
|
|
|
11079
11322
|
| "dotplotType";
|
|
11080
11323
|
/** Config keys in the "Dumbbell Graphs" category. */
|
|
11081
11324
|
export type CXKeysDumbbellGraphs =
|
|
11325
|
+
| "dumbbellArrowDirection"
|
|
11082
11326
|
| "dumbbellType";
|
|
11083
11327
|
/** Config keys in the "Error Bars" category. */
|
|
11084
11328
|
export type CXKeysErrorBars =
|
|
@@ -11482,6 +11726,7 @@ export type CXKeysLineGraphs =
|
|
|
11482
11726
|
| "lineDecoration"
|
|
11483
11727
|
| "lineErrorType"
|
|
11484
11728
|
| "lineType"
|
|
11729
|
+
| "showLineEndLabels"
|
|
11485
11730
|
| "tension"
|
|
11486
11731
|
| "tensionSegments";
|
|
11487
11732
|
/** Config keys in the "Lines" category. */
|
|
@@ -11530,16 +11775,20 @@ export type CXKeysManhattanPlots =
|
|
|
11530
11775
|
/** Config keys in the "Maps" category. */
|
|
11531
11776
|
export type CXKeysMaps =
|
|
11532
11777
|
| "hiddenMapFeatures"
|
|
11778
|
+
| "mapBubbleColor"
|
|
11533
11779
|
| "mapColor"
|
|
11534
11780
|
| "mapConfig"
|
|
11535
11781
|
| "mapConfigFeatures"
|
|
11536
11782
|
| "mapId"
|
|
11783
|
+
| "mapLabelColor"
|
|
11784
|
+
| "mapLabelProperty"
|
|
11537
11785
|
| "mapMarkerShape"
|
|
11538
11786
|
| "mapMarkerShapeScaleFactor"
|
|
11539
11787
|
| "mapOutlineColor"
|
|
11540
11788
|
| "mapProjection"
|
|
11541
11789
|
| "mapSmps"
|
|
11542
11790
|
| "mapZipCodeIds"
|
|
11791
|
+
| "showMapLabels"
|
|
11543
11792
|
| "topoJSON"
|
|
11544
11793
|
| "visibleMapFeatures";
|
|
11545
11794
|
/** Config keys in the "Maps Albers" category. */
|
|
@@ -11772,6 +12021,7 @@ export type CXKeysPieCharts =
|
|
|
11772
12021
|
| "pieSegmentLabels"
|
|
11773
12022
|
| "pieSegmentPrecision"
|
|
11774
12023
|
| "pieSegmentSeparation"
|
|
12024
|
+
| "pieShape"
|
|
11775
12025
|
| "pieType"
|
|
11776
12026
|
| "showPieSampleLabel"
|
|
11777
12027
|
| "showPieValues"
|
|
@@ -11807,7 +12057,8 @@ export type CXKeysPlotDataType =
|
|
|
11807
12057
|
| "isCxplot"
|
|
11808
12058
|
| "isDataFrame"
|
|
11809
12059
|
| "isGGMatrix"
|
|
11810
|
-
| "isR"
|
|
12060
|
+
| "isR"
|
|
12061
|
+
| "responsiveRules";
|
|
11811
12062
|
/** Config keys in the "Plot Mode" category. */
|
|
11812
12063
|
export type CXKeysPlotMode =
|
|
11813
12064
|
| "isEditable"
|
|
@@ -11874,6 +12125,7 @@ export type CXKeysRAxis =
|
|
|
11874
12125
|
| "rAxisLogTicksShow"
|
|
11875
12126
|
| "rAxisLogTicksTransparency"
|
|
11876
12127
|
| "rAxisLogTicksWidth"
|
|
12128
|
+
| "rAxisNumberFormat"
|
|
11877
12129
|
| "rAxisPercentShow"
|
|
11878
12130
|
| "rAxisSetLabels"
|
|
11879
12131
|
| "rAxisSetMinorValues"
|
|
@@ -12078,6 +12330,7 @@ export type CXKeysText =
|
|
|
12078
12330
|
| "align"
|
|
12079
12331
|
| "autoScaleFont"
|
|
12080
12332
|
| "baseline"
|
|
12333
|
+
| "dataLabelNumberFormat"
|
|
12081
12334
|
| "fontColor"
|
|
12082
12335
|
| "fontName"
|
|
12083
12336
|
| "fontScaleFontFactor"
|
|
@@ -12085,8 +12338,11 @@ export type CXKeysText =
|
|
|
12085
12338
|
| "fontStyle"
|
|
12086
12339
|
| "fonts"
|
|
12087
12340
|
| "fontsExternal"
|
|
12341
|
+
| "legendNumberFormat"
|
|
12088
12342
|
| "maxTextSize"
|
|
12089
|
-
| "minTextSize"
|
|
12343
|
+
| "minTextSize"
|
|
12344
|
+
| "numberFormat"
|
|
12345
|
+
| "tooltipNumberFormat";
|
|
12090
12346
|
/** Config keys in the "Text Placement" category. */
|
|
12091
12347
|
export type CXKeysTextPlacement =
|
|
12092
12348
|
| "optimizeTextPosition"
|
|
@@ -12096,6 +12352,7 @@ export type CXKeysTextPlacement =
|
|
|
12096
12352
|
| "optimizeTextPositionTemperature";
|
|
12097
12353
|
/** Config keys in the "Titles and Subtitles" category. */
|
|
12098
12354
|
export type CXKeysTitlesandSubtitles =
|
|
12355
|
+
| "a11yDescription"
|
|
12099
12356
|
| "subtitle"
|
|
12100
12357
|
| "subtitleAlign"
|
|
12101
12358
|
| "subtitleBaseline"
|
|
@@ -12247,6 +12504,7 @@ export type CXKeysXAxis =
|
|
|
12247
12504
|
| "setPanningMinX"
|
|
12248
12505
|
| "xAxis"
|
|
12249
12506
|
| "xAxis2"
|
|
12507
|
+
| "xAxis2NumberFormat"
|
|
12250
12508
|
| "xAxis2Rotate"
|
|
12251
12509
|
| "xAxis2Show"
|
|
12252
12510
|
| "xAxis2TickFormat"
|
|
@@ -12286,6 +12544,7 @@ export type CXKeysXAxis =
|
|
|
12286
12544
|
| "xAxisLogTicksTransparency"
|
|
12287
12545
|
| "xAxisLogTicksWidth"
|
|
12288
12546
|
| "xAxisMinorTicks"
|
|
12547
|
+
| "xAxisNumberFormat"
|
|
12289
12548
|
| "xAxisRugHeight"
|
|
12290
12549
|
| "xAxisRugPosition"
|
|
12291
12550
|
| "xAxisRugShow"
|
|
@@ -12367,6 +12626,7 @@ export type CXKeysYAxis =
|
|
|
12367
12626
|
| "yAxisLogTicksTransparency"
|
|
12368
12627
|
| "yAxisLogTicksWidth"
|
|
12369
12628
|
| "yAxisMinorTicks"
|
|
12629
|
+
| "yAxisNumberFormat"
|
|
12370
12630
|
| "yAxisRugHeight"
|
|
12371
12631
|
| "yAxisRugPosition"
|
|
12372
12632
|
| "yAxisRugShow"
|
|
@@ -12431,6 +12691,7 @@ export type CXKeysZAxis =
|
|
|
12431
12691
|
| "zAxisLogTicksShow"
|
|
12432
12692
|
| "zAxisLogTicksTransparency"
|
|
12433
12693
|
| "zAxisLogTicksWidth"
|
|
12694
|
+
| "zAxisNumberFormat"
|
|
12434
12695
|
| "zAxisSetLabels"
|
|
12435
12696
|
| "zAxisSetMinorValues"
|
|
12436
12697
|
| "zAxisSetValues"
|