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/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 (1732 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
|
|
@@ -144,6 +144,13 @@ declare namespace CanvasXpress {
|
|
|
144
144
|
* @default {}
|
|
145
145
|
*/
|
|
146
146
|
Rdataset?: Record<string, unknown> | boolean;
|
|
147
|
+
/**
|
|
148
|
+
* Author-written text alternative (alt text) for screen readers. When set it replaces the
|
|
149
|
+
* generated chart summary in the canvas aria-label and is added to SVG exports as their
|
|
150
|
+
* title and description
|
|
151
|
+
* @default false
|
|
152
|
+
*/
|
|
153
|
+
a11yDescription?: string | boolean;
|
|
147
154
|
/**
|
|
148
155
|
* Flag to ensure the heatmap indicator scales appropriately when the graph is rendered or
|
|
149
156
|
* the user manually resizes the graph, the adjustAspectRatio flag must be set to true for
|
|
@@ -697,6 +704,11 @@ declare namespace CanvasXpress {
|
|
|
697
704
|
* @default 0.5
|
|
698
705
|
*/
|
|
699
706
|
bulletWidthRatio?: number | boolean;
|
|
707
|
+
/**
|
|
708
|
+
* Author or organization credit shown in the chart footer, e.g. "Chart: Jane Doe"
|
|
709
|
+
* @default false
|
|
710
|
+
*/
|
|
711
|
+
byline?: string | boolean;
|
|
700
712
|
/**
|
|
701
713
|
* Flag to cache image in meta data as Base64
|
|
702
714
|
* @default false
|
|
@@ -1019,6 +1031,13 @@ declare namespace CanvasXpress {
|
|
|
1019
1031
|
* @default false
|
|
1020
1032
|
*/
|
|
1021
1033
|
colorLabelBy?: string | boolean;
|
|
1034
|
+
/**
|
|
1035
|
+
* Numeric colour legend for binned colouring: equal draws one equal-width swatch per class
|
|
1036
|
+
* with every class edge labelled (stepped legend); proportional sizes swatches by their
|
|
1037
|
+
* value range; auto is equal with a colorSpectrumBreaksMethod, else proportional
|
|
1038
|
+
* @default "auto"
|
|
1039
|
+
*/
|
|
1040
|
+
colorLegendSteps?: "auto" | "proportional" | "equal" | false | (string & {});
|
|
1022
1041
|
/**
|
|
1023
1042
|
* Title for the color legend
|
|
1024
1043
|
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
@@ -1061,6 +1080,13 @@ declare namespace CanvasXpress {
|
|
|
1061
1080
|
* @default []
|
|
1062
1081
|
*/
|
|
1063
1082
|
colorSpectrumBreaks?: unknown[] | boolean | string | number;
|
|
1083
|
+
/**
|
|
1084
|
+
* Classify the colorBy values into one colour class per colorSpectrum colour (a classed
|
|
1085
|
+
* choropleth): jenks (natural breaks), quantile (equal count) or equalWidth. Computes the
|
|
1086
|
+
* colorSpectrumBreaks and turns on binned colouring
|
|
1087
|
+
* @default false
|
|
1088
|
+
*/
|
|
1089
|
+
colorSpectrumBreaksMethod?: string | boolean;
|
|
1064
1090
|
/**
|
|
1065
1091
|
* Color spectrum by factor in heatmaps. The first key represents the name of the factor
|
|
1066
1092
|
* within the x/z data object. The subsequent keys correspond to each level of that factor.
|
|
@@ -1435,6 +1461,15 @@ declare namespace CanvasXpress {
|
|
|
1435
1461
|
* @default "rgb(255,255,255)"
|
|
1436
1462
|
*/
|
|
1437
1463
|
dataLabelBackgroundColor?: string | boolean;
|
|
1464
|
+
/**
|
|
1465
|
+
* Number format for the data values drawn on the chart (showDataValues and data labels).
|
|
1466
|
+
* Overrides numberFormat. It could be a preset name (comma, percent, dollar, euro, pound,
|
|
1467
|
+
* yen, compact), a sprintf format string, or an object, i.e. {"locale": "en-US", "style":
|
|
1468
|
+
* "decimal|percent|currency|compact", "currency": "USD", "decimals": 1, "grouping": true,
|
|
1469
|
+
* "prefix": "", "suffix": ""}. Uses Intl.NumberFormat when available
|
|
1470
|
+
* @default false
|
|
1471
|
+
*/
|
|
1472
|
+
dataLabelNumberFormat?: string | Record<string, unknown> | boolean;
|
|
1438
1473
|
/**
|
|
1439
1474
|
* A declarative dplyr/tidyr data-grammar recipe applied over the tidy substrate BEFORE the
|
|
1440
1475
|
* chart wrangle. An ordered array of ops: {op:"filter", col, cmp (one of
|
|
@@ -1621,8 +1656,9 @@ declare namespace CanvasXpress {
|
|
|
1621
1656
|
*/
|
|
1622
1657
|
dataTableColAlignment?: Record<string, unknown> | boolean;
|
|
1623
1658
|
/**
|
|
1624
|
-
* Format for the cols in the data table. Key is the sample name and the value is
|
|
1625
|
-
* string
|
|
1659
|
+
* Format for the cols in the data table. Key is the sample name and the value is a sprintf
|
|
1660
|
+
* format string, a number-format preset (comma, percent, dollar, euro, pound, yen, compact)
|
|
1661
|
+
* or a number-format object {locale, style, currency, decimals}
|
|
1626
1662
|
* @default {}
|
|
1627
1663
|
*/
|
|
1628
1664
|
dataTableColFormat?: Record<string, unknown> | boolean;
|
|
@@ -1649,6 +1685,15 @@ declare namespace CanvasXpress {
|
|
|
1649
1685
|
* @default {}
|
|
1650
1686
|
*/
|
|
1651
1687
|
dataTableColProperties?: Record<string, unknown> | boolean;
|
|
1688
|
+
/**
|
|
1689
|
+
* In-cell graphics per column of the data table. Key is the column name and the value is bar
|
|
1690
|
+
* (a bar behind the value scaled to the column, from zero when the column has negatives),
|
|
1691
|
+
* {type: bar, color}, or {type: sparkline, columns: [...], color, width, height, showValue}
|
|
1692
|
+
* (a small line of the row values across those columns, replacing the value unless
|
|
1693
|
+
* showValue)
|
|
1694
|
+
* @default {}
|
|
1695
|
+
*/
|
|
1696
|
+
dataTableColRenderer?: Record<string, unknown> | boolean;
|
|
1652
1697
|
/**
|
|
1653
1698
|
* Number of pixels for the width of cells in the data table
|
|
1654
1699
|
* @default 180
|
|
@@ -1664,6 +1709,18 @@ declare namespace CanvasXpress {
|
|
|
1664
1709
|
* @default false
|
|
1665
1710
|
*/
|
|
1666
1711
|
dataTableColored?: boolean;
|
|
1712
|
+
/**
|
|
1713
|
+
* Flag to shrink the data table to the height of its rows when they do not fill the space
|
|
1714
|
+
* (no empty area under the last row); a longer table still scrolls
|
|
1715
|
+
* @default false
|
|
1716
|
+
*/
|
|
1717
|
+
dataTableFitHeight?: boolean;
|
|
1718
|
+
/**
|
|
1719
|
+
* Flag to narrow the data table to the width of its columns when they do not fill the space
|
|
1720
|
+
* (no empty area after the last column); a wider table still scrolls
|
|
1721
|
+
* @default false
|
|
1722
|
+
*/
|
|
1723
|
+
dataTableFitWidth?: boolean;
|
|
1667
1724
|
/**
|
|
1668
1725
|
* Flag to group rows in the data table based on metadata
|
|
1669
1726
|
* @default false
|
|
@@ -1674,6 +1731,13 @@ declare namespace CanvasXpress {
|
|
|
1674
1731
|
* @default "rgb(255, 255, 255)"
|
|
1675
1732
|
*/
|
|
1676
1733
|
dataTableHeaderBackgroundColor?: string | boolean;
|
|
1734
|
+
/**
|
|
1735
|
+
* When the data table header cells show their menu, filter and resize icons: always, only
|
|
1736
|
+
* while the header cell is hovered, or auto (on hover with the minimal dataUIStyle, always
|
|
1737
|
+
* otherwise). Sorting arrows and the filter of a filtered column always show
|
|
1738
|
+
* @default "auto"
|
|
1739
|
+
*/
|
|
1740
|
+
dataTableHeaderIcons?: "auto" | "always" | "hover" | false | (string & {});
|
|
1677
1741
|
/**
|
|
1678
1742
|
* HTML string to use as template for the data table header info
|
|
1679
1743
|
* @default false
|
|
@@ -2042,7 +2106,7 @@ declare namespace CanvasXpress {
|
|
|
2042
2106
|
* Style for the UI
|
|
2043
2107
|
* @default "modern"
|
|
2044
2108
|
*/
|
|
2045
|
-
dataUIStyle?: "cx" | "stripped" | "modern" | "old" | "bms" | "colorful" | "rdc" | "ngs360" | false | (string & {});
|
|
2109
|
+
dataUIStyle?: "cx" | "stripped" | "minimal" | "modern" | "old" | "bms" | "colorful" | "rdc" | "ngs360" | false | (string & {});
|
|
2046
2110
|
/**
|
|
2047
2111
|
* Frequency for the data values in line graphs
|
|
2048
2112
|
* @graphTypes Area, AreaLine, Bar, BarLine, Boxplot, Bullet … (31 types; see CXGraphTypeKeys)
|
|
@@ -2382,6 +2446,13 @@ declare namespace CanvasXpress {
|
|
|
2382
2446
|
* @default "normal"
|
|
2383
2447
|
*/
|
|
2384
2448
|
dotplotType?: "arrow" | "bullet" | "cleveland" | "connected" | "line" | "lineConnected" | "normal" | "stacked" | "transition" | false | (string & {});
|
|
2449
|
+
/**
|
|
2450
|
+
* Direction of the arrows in arrow dumbbells (dumbbellType arrow): value points each arrow
|
|
2451
|
+
* at the smaller value; order points from the first variable to the next (before to after)
|
|
2452
|
+
* @graphTypes Boxplot, Cleveland, DotLine, Dotplot, Dumbbell, Violin
|
|
2453
|
+
* @default "value"
|
|
2454
|
+
*/
|
|
2455
|
+
dumbbellArrowDirection?: "value" | "order" | false | (string & {});
|
|
2385
2456
|
/**
|
|
2386
2457
|
* Style for the dumbbell plot
|
|
2387
2458
|
* @graphTypes Boxplot, Cleveland, DotLine, Dotplot, Dumbbell, Violin
|
|
@@ -2788,6 +2859,12 @@ declare namespace CanvasXpress {
|
|
|
2788
2859
|
* @default []
|
|
2789
2860
|
*/
|
|
2790
2861
|
fontsExternal?: unknown[] | boolean | string | number;
|
|
2862
|
+
/**
|
|
2863
|
+
* Horizontal alignment for the structured chart footer (notes, source, byline, data
|
|
2864
|
+
* download)
|
|
2865
|
+
* @default "left"
|
|
2866
|
+
*/
|
|
2867
|
+
footerAlign?: "left" | "center" | "right" | false | (string & {});
|
|
2791
2868
|
/**
|
|
2792
2869
|
* Number of future steps to forecast. 0 uses the forecast package default: 10, or two
|
|
2793
2870
|
* seasons when forecastSeasonLength is greater than 1
|
|
@@ -3951,6 +4028,15 @@ declare namespace CanvasXpress {
|
|
|
3951
4028
|
* @default 50
|
|
3952
4029
|
*/
|
|
3953
4030
|
legendMax?: number | boolean;
|
|
4031
|
+
/**
|
|
4032
|
+
* Number format for numeric values displayed in legends (continuous color ramps and size-by
|
|
4033
|
+
* bins). Overrides numberFormat. It could be a preset name (comma, percent, dollar, euro,
|
|
4034
|
+
* pound, yen, compact), a sprintf format string, or an object, i.e. {"locale": "en-US",
|
|
4035
|
+
* "style": "decimal|percent|currency|compact", "currency": "USD", "decimals": 1, "grouping":
|
|
4036
|
+
* true, "prefix": "", "suffix": ""}. Uses Intl.NumberFormat when available
|
|
4037
|
+
* @default false
|
|
4038
|
+
*/
|
|
4039
|
+
legendNumberFormat?: string | Record<string, unknown> | boolean;
|
|
3954
4040
|
/**
|
|
3955
4041
|
* Object to specify custom order for the levels in the legends. The key of the object is the
|
|
3956
4042
|
* name of a valid sample or variable annotation included in the data object. The value for
|
|
@@ -4343,6 +4429,13 @@ declare namespace CanvasXpress {
|
|
|
4343
4429
|
* @default false
|
|
4344
4430
|
*/
|
|
4345
4431
|
manhattanRangeStart?: string | boolean;
|
|
4432
|
+
/**
|
|
4433
|
+
* Color for the region bubbles on maps (sizeBy a sample: a circle per region sized by its
|
|
4434
|
+
* value); the size legend uses it too
|
|
4435
|
+
* @graphTypes Map
|
|
4436
|
+
* @default "rgba(255,0,0,0.6)"
|
|
4437
|
+
*/
|
|
4438
|
+
mapBubbleColor?: string | boolean;
|
|
4346
4439
|
/**
|
|
4347
4440
|
* Map Latitude Of Origin in degrees. (Applicable to Albers projection only). Default adjusts
|
|
4348
4441
|
* to USA maps
|
|
@@ -4386,6 +4479,20 @@ declare namespace CanvasXpress {
|
|
|
4386
4479
|
* @default false
|
|
4387
4480
|
*/
|
|
4388
4481
|
mapId?: string | boolean;
|
|
4482
|
+
/**
|
|
4483
|
+
* Color for the region labels on maps. Defaults to black or white, whichever contrasts with
|
|
4484
|
+
* the region fill
|
|
4485
|
+
* @graphTypes Map
|
|
4486
|
+
* @default false
|
|
4487
|
+
*/
|
|
4488
|
+
mapLabelColor?: string | boolean;
|
|
4489
|
+
/**
|
|
4490
|
+
* Map feature property used as the region label (defaults to name, then NAME, then the
|
|
4491
|
+
* region key)
|
|
4492
|
+
* @graphTypes Map
|
|
4493
|
+
* @default false
|
|
4494
|
+
*/
|
|
4495
|
+
mapLabelProperty?: string | boolean;
|
|
4389
4496
|
/**
|
|
4390
4497
|
* Map Latitude Of Origin in degrees. (Applicable to Albers projection only). Default adjusts
|
|
4391
4498
|
* to USA maps
|
|
@@ -4971,6 +5078,21 @@ declare namespace CanvasXpress {
|
|
|
4971
5078
|
* @default 1
|
|
4972
5079
|
*/
|
|
4973
5080
|
nodeSizeScaleFactor?: number | boolean;
|
|
5081
|
+
/**
|
|
5082
|
+
* Footer notes drawn above the source line at the bottom of the chart. Newlines split into
|
|
5083
|
+
* multiple lines
|
|
5084
|
+
* @default false
|
|
5085
|
+
*/
|
|
5086
|
+
notes?: string | boolean;
|
|
5087
|
+
/**
|
|
5088
|
+
* Default number format for values displayed in axis ticks, tooltips, legends and data
|
|
5089
|
+
* labels. It could be a preset name (comma, percent, dollar, euro, pound, yen, compact), a
|
|
5090
|
+
* sprintf format string, or an object, i.e. {"locale": "en-US", "style":
|
|
5091
|
+
* "decimal|percent|currency|compact", "currency": "USD", "decimals": 1, "grouping": true,
|
|
5092
|
+
* "prefix": "", "suffix": ""}. Uses Intl.NumberFormat when available
|
|
5093
|
+
* @default false
|
|
5094
|
+
*/
|
|
5095
|
+
numberFormat?: string | Record<string, unknown> | boolean;
|
|
4974
5096
|
/**
|
|
4975
5097
|
* Sort group keys numerically (type-aware: plain integers, range labels, composite keys)
|
|
4976
5098
|
* instead of lexicographically
|
|
@@ -5441,11 +5563,19 @@ declare namespace CanvasXpress {
|
|
|
5441
5563
|
*/
|
|
5442
5564
|
pieSegmentSeparation?: number | boolean;
|
|
5443
5565
|
/**
|
|
5444
|
-
*
|
|
5566
|
+
* Shape of the pie: a full circle, or a half circle (semicircle, e.g. an election donut with
|
|
5567
|
+
* pieInnerRadius)
|
|
5568
|
+
* @graphTypes Pie
|
|
5569
|
+
* @default "full"
|
|
5570
|
+
*/
|
|
5571
|
+
pieShape?: "full" | "half" | false | (string & {});
|
|
5572
|
+
/**
|
|
5573
|
+
* Position for the pices of the pie. parliament draws one dot per seat on a hemicycle (the
|
|
5574
|
+
* values are seat counts), grouped by party from left to right
|
|
5445
5575
|
* @graphTypes Pie
|
|
5446
5576
|
* @default "separated"
|
|
5447
5577
|
*/
|
|
5448
|
-
pieType?: "separated" | "solid" | false | (string & {});
|
|
5578
|
+
pieType?: "separated" | "solid" | "parliament" | false | (string & {});
|
|
5449
5579
|
/**
|
|
5450
5580
|
* Utility to pivot data with a sample annotation
|
|
5451
5581
|
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
@@ -5673,6 +5803,16 @@ declare namespace CanvasXpress {
|
|
|
5673
5803
|
* @default 1
|
|
5674
5804
|
*/
|
|
5675
5805
|
rAxisLogTicksWidth?: number | boolean;
|
|
5806
|
+
/**
|
|
5807
|
+
* Locale-aware number format for the tick values in the R axis. Overrides numberFormat for
|
|
5808
|
+
* this axis; an explicit rAxisTickFormat takes precedence over it. It could be a preset name
|
|
5809
|
+
* (comma, percent, dollar, euro, pound, yen, compact), a sprintf format string, or an
|
|
5810
|
+
* object, i.e. {"locale": "en-US", "style": "decimal|percent|currency|compact", "currency":
|
|
5811
|
+
* "USD", "decimals": 1, "grouping": true, "prefix": "", "suffix": ""}
|
|
5812
|
+
* @graphTypes Circular
|
|
5813
|
+
* @default false
|
|
5814
|
+
*/
|
|
5815
|
+
rAxisNumberFormat?: string | Record<string, unknown> | boolean;
|
|
5676
5816
|
/**
|
|
5677
5817
|
* Flag to show on not the percent in each segment in the R axis
|
|
5678
5818
|
* @graphTypes Circular
|
|
@@ -6012,6 +6152,15 @@ declare namespace CanvasXpress {
|
|
|
6012
6152
|
* @default true
|
|
6013
6153
|
*/
|
|
6014
6154
|
resizableY?: boolean;
|
|
6155
|
+
/**
|
|
6156
|
+
* Width-based config overrides applied on render/resize, i.e. [{"maxWidth": 480, "config":
|
|
6157
|
+
* {"legendPosition": "bottom", "fontScaleFontFactor": 0.8}}]. A rule matches when the canvas
|
|
6158
|
+
* width is <= maxWidth and >= minWidth (either bound optional); later rules win on
|
|
6159
|
+
* conflicting keys. Overrides revert automatically when the width stops matching and are
|
|
6160
|
+
* never saved into the configuration
|
|
6161
|
+
* @default []
|
|
6162
|
+
*/
|
|
6163
|
+
responsiveRules?: unknown[] | boolean | string | number;
|
|
6015
6164
|
/**
|
|
6016
6165
|
* Name of a sample annotation(s) to create a ribbon of each variable in scatter plots. If a
|
|
6017
6166
|
* single annotation is passed then it will be used as a standard deviation. If two
|
|
@@ -7058,6 +7207,12 @@ declare namespace CanvasXpress {
|
|
|
7058
7207
|
* @default false
|
|
7059
7208
|
*/
|
|
7060
7209
|
showContourLevel?: boolean;
|
|
7210
|
+
/**
|
|
7211
|
+
* Flag to show a "Get the data" link in the chart footer which downloads the current data as
|
|
7212
|
+
* CSV
|
|
7213
|
+
* @default false
|
|
7214
|
+
*/
|
|
7215
|
+
showDataDownload?: boolean;
|
|
7061
7216
|
/**
|
|
7062
7217
|
* Flag to show/hide the data labels in scatter plots
|
|
7063
7218
|
* @graphTypes Bin, Binplot, Bump, CDF, Contour, Density … (22 types; see CXGraphTypeKeys)
|
|
@@ -7225,6 +7380,13 @@ declare namespace CanvasXpress {
|
|
|
7225
7380
|
* @default true
|
|
7226
7381
|
*/
|
|
7227
7382
|
showLineEdgeLegend?: boolean;
|
|
7383
|
+
/**
|
|
7384
|
+
* Flag to show/hide the series name at the end of each line in line graphs, in the series
|
|
7385
|
+
* color, replacing the legend (direct labeling). Overlapping labels are nudged apart
|
|
7386
|
+
* @graphTypes Area, AreaLine, BarLine, DotLine, Line, ParallelCoordinates … (9 types; see CXGraphTypeKeys)
|
|
7387
|
+
* @default false
|
|
7388
|
+
*/
|
|
7389
|
+
showLineEndLabels?: boolean;
|
|
7228
7390
|
/**
|
|
7229
7391
|
* Flag to show/hide the legend line
|
|
7230
7392
|
* @graphTypes Bar, BarLine, Boxplot, Bullet, Cleveland, DotLine … (19 types; see CXGraphTypeKeys)
|
|
@@ -7238,6 +7400,13 @@ declare namespace CanvasXpress {
|
|
|
7238
7400
|
* @default false
|
|
7239
7401
|
*/
|
|
7240
7402
|
showLoessFit?: string | boolean;
|
|
7403
|
+
/**
|
|
7404
|
+
* Flag to show/hide the region labels on maps (only labels that fit inside their region
|
|
7405
|
+
* without overlapping another label are drawn, largest regions first)
|
|
7406
|
+
* @graphTypes Map
|
|
7407
|
+
* @default false
|
|
7408
|
+
*/
|
|
7409
|
+
showMapLabels?: boolean;
|
|
7241
7410
|
/**
|
|
7242
7411
|
* Flag to show/hide the the overlays name
|
|
7243
7412
|
* @graphTypes Bar, BarLine, Boxplot, Bullet, Cleveland, DotLine … (19 types; see CXGraphTypeKeys)
|
|
@@ -7799,6 +7968,18 @@ declare namespace CanvasXpress {
|
|
|
7799
7968
|
* @default false
|
|
7800
7969
|
*/
|
|
7801
7970
|
sortOnGrouping?: string | boolean;
|
|
7971
|
+
/**
|
|
7972
|
+
* Data source name shown in the chart footer as "Source: ...". Combine with sourceUrl to
|
|
7973
|
+
* make it a link
|
|
7974
|
+
* @default false
|
|
7975
|
+
*/
|
|
7976
|
+
source?: string | boolean;
|
|
7977
|
+
/**
|
|
7978
|
+
* URL for the footer data source. When set with source, the "Source: ..." footer text
|
|
7979
|
+
* becomes a clickable link (exports still include the text)
|
|
7980
|
+
* @default false
|
|
7981
|
+
*/
|
|
7982
|
+
sourceUrl?: string | boolean;
|
|
7802
7983
|
/**
|
|
7803
7984
|
* Factor (in the x data object) used to split the samples ala split in a complex heatmap.
|
|
7804
7985
|
* Unlike segregateSamplesBy, the split keeps a single full-width plot and only inserts a
|
|
@@ -8224,6 +8405,15 @@ declare namespace CanvasXpress {
|
|
|
8224
8405
|
* @default false
|
|
8225
8406
|
*/
|
|
8226
8407
|
tooltipFontColor?: string | boolean;
|
|
8408
|
+
/**
|
|
8409
|
+
* Number format for values displayed in tooltips. Overrides numberFormat. It could be a
|
|
8410
|
+
* preset name (comma, percent, dollar, euro, pound, yen, compact), a sprintf format string,
|
|
8411
|
+
* or an object, i.e. {"locale": "en-US", "style": "decimal|percent|currency|compact",
|
|
8412
|
+
* "currency": "USD", "decimals": 1, "grouping": true, "prefix": "", "suffix": ""}. Uses
|
|
8413
|
+
* Intl.NumberFormat when available
|
|
8414
|
+
* @default false
|
|
8415
|
+
*/
|
|
8416
|
+
tooltipNumberFormat?: string | Record<string, unknown> | boolean;
|
|
8227
8417
|
/**
|
|
8228
8418
|
* Transparency for the tooltip
|
|
8229
8419
|
* @default null
|
|
@@ -9154,6 +9344,17 @@ declare namespace CanvasXpress {
|
|
|
9154
9344
|
* @default []
|
|
9155
9345
|
*/
|
|
9156
9346
|
xAxis2?: unknown[] | boolean | string | number;
|
|
9347
|
+
/**
|
|
9348
|
+
* Locale-aware number format for the tick values in the second X axis. Overrides
|
|
9349
|
+
* numberFormat for this axis; an explicit xAxis2TickFormat takes precedence over it. It
|
|
9350
|
+
* could be a preset name (comma, percent, dollar, euro, pound, yen, compact), a sprintf
|
|
9351
|
+
* format string, or an object, i.e. {"locale": "en-US", "style":
|
|
9352
|
+
* "decimal|percent|currency|compact", "currency": "USD", "decimals": 1, "grouping": true,
|
|
9353
|
+
* "prefix": "", "suffix": ""}
|
|
9354
|
+
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
9355
|
+
* @default false
|
|
9356
|
+
*/
|
|
9357
|
+
xAxis2NumberFormat?: string | Record<string, unknown> | boolean;
|
|
9157
9358
|
/**
|
|
9158
9359
|
* Flag to rotate 180 degrees the direction of the X axis on the top
|
|
9159
9360
|
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
@@ -9392,6 +9593,16 @@ declare namespace CanvasXpress {
|
|
|
9392
9593
|
* @default 2
|
|
9393
9594
|
*/
|
|
9394
9595
|
xAxisMinorTicks?: number | boolean;
|
|
9596
|
+
/**
|
|
9597
|
+
* Locale-aware number format for the tick values in the X axis. Overrides numberFormat for
|
|
9598
|
+
* this axis; an explicit xAxisTickFormat takes precedence over it. It could be a preset name
|
|
9599
|
+
* (comma, percent, dollar, euro, pound, yen, compact), a sprintf format string, or an
|
|
9600
|
+
* object, i.e. {"locale": "en-US", "style": "decimal|percent|currency|compact", "currency":
|
|
9601
|
+
* "USD", "decimals": 1, "grouping": true, "prefix": "", "suffix": ""}
|
|
9602
|
+
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
9603
|
+
* @default false
|
|
9604
|
+
*/
|
|
9605
|
+
xAxisNumberFormat?: string | Record<string, unknown> | boolean;
|
|
9395
9606
|
/**
|
|
9396
9607
|
* Size in pixels for the data rug in the X axis
|
|
9397
9608
|
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
@@ -9862,6 +10073,16 @@ declare namespace CanvasXpress {
|
|
|
9862
10073
|
* @default 2
|
|
9863
10074
|
*/
|
|
9864
10075
|
yAxisMinorTicks?: number | boolean;
|
|
10076
|
+
/**
|
|
10077
|
+
* Locale-aware number format for the tick values in the Y axis. Overrides numberFormat for
|
|
10078
|
+
* this axis; an explicit yAxisTickFormat takes precedence over it. It could be a preset name
|
|
10079
|
+
* (comma, percent, dollar, euro, pound, yen, compact), a sprintf format string, or an
|
|
10080
|
+
* object, i.e. {"locale": "en-US", "style": "decimal|percent|currency|compact", "currency":
|
|
10081
|
+
* "USD", "decimals": 1, "grouping": true, "prefix": "", "suffix": ""}
|
|
10082
|
+
* @graphTypes Bin, Binplot, CDF, Contour, Density, Distribution … (21 types; see CXGraphTypeKeys)
|
|
10083
|
+
* @default false
|
|
10084
|
+
*/
|
|
10085
|
+
yAxisNumberFormat?: string | Record<string, unknown> | boolean;
|
|
9865
10086
|
/**
|
|
9866
10087
|
* Size in pixels for the data rug in the Y axis
|
|
9867
10088
|
* @graphTypes Bin, Binplot, CDF, Contour, Density, Distribution … (21 types; see CXGraphTypeKeys)
|
|
@@ -10251,6 +10472,16 @@ declare namespace CanvasXpress {
|
|
|
10251
10472
|
* @default 1
|
|
10252
10473
|
*/
|
|
10253
10474
|
zAxisLogTicksWidth?: number | boolean;
|
|
10475
|
+
/**
|
|
10476
|
+
* Locale-aware number format for the tick values in the Z axis. Overrides numberFormat for
|
|
10477
|
+
* this axis; an explicit zAxisTickFormat takes precedence over it. It could be a preset name
|
|
10478
|
+
* (comma, percent, dollar, euro, pound, yen, compact), a sprintf format string, or an
|
|
10479
|
+
* object, i.e. {"locale": "en-US", "style": "decimal|percent|currency|compact", "currency":
|
|
10480
|
+
* "USD", "decimals": 1, "grouping": true, "prefix": "", "suffix": ""}
|
|
10481
|
+
* @graphTypes ScatterBubble2D, Scatter3D
|
|
10482
|
+
* @default false
|
|
10483
|
+
*/
|
|
10484
|
+
zAxisNumberFormat?: string | Record<string, unknown> | boolean;
|
|
10254
10485
|
/**
|
|
10255
10486
|
* Set the tick labels paired one-to-one with zAxisSetValues in the Z axis
|
|
10256
10487
|
* @graphTypes ScatterBubble2D, Scatter3D
|
|
@@ -10649,6 +10880,7 @@ declare namespace CanvasXpress {
|
|
|
10649
10880
|
| "circularType";
|
|
10650
10881
|
/** Config keys in the "Citations or References" category. */
|
|
10651
10882
|
export type CXKeysCitationsorReferences =
|
|
10883
|
+
| "byline"
|
|
10652
10884
|
| "citation"
|
|
10653
10885
|
| "citationAlign"
|
|
10654
10886
|
| "citationBaseline"
|
|
@@ -10657,7 +10889,12 @@ declare namespace CanvasXpress {
|
|
|
10657
10889
|
| "citationFontStyle"
|
|
10658
10890
|
| "citationMargin"
|
|
10659
10891
|
| "citationRotate"
|
|
10660
|
-
| "citationScaleFontFactor"
|
|
10892
|
+
| "citationScaleFontFactor"
|
|
10893
|
+
| "footerAlign"
|
|
10894
|
+
| "notes"
|
|
10895
|
+
| "showDataDownload"
|
|
10896
|
+
| "source"
|
|
10897
|
+
| "sourceUrl";
|
|
10661
10898
|
/** Config keys in the "Clustering" category. */
|
|
10662
10899
|
export type CXKeysClustering =
|
|
10663
10900
|
| "clusterAxis"
|
|
@@ -10674,10 +10911,12 @@ declare namespace CanvasXpress {
|
|
|
10674
10911
|
/** Config keys in the "Colors" category. */
|
|
10675
10912
|
export type CXKeysColors =
|
|
10676
10913
|
| "blindnessType"
|
|
10914
|
+
| "colorLegendSteps"
|
|
10677
10915
|
| "colorScheme"
|
|
10678
10916
|
| "colorSpectrum"
|
|
10679
10917
|
| "colorSpectrumBinned"
|
|
10680
10918
|
| "colorSpectrumBreaks"
|
|
10919
|
+
| "colorSpectrumBreaksMethod"
|
|
10681
10920
|
| "colorSpectrumByFactor"
|
|
10682
10921
|
| "colorSpectrumByObject"
|
|
10683
10922
|
| "colorSpectrumZeroValue"
|
|
@@ -10929,11 +11168,15 @@ declare namespace CanvasXpress {
|
|
|
10929
11168
|
| "dataTableColOrder"
|
|
10930
11169
|
| "dataTableColPin"
|
|
10931
11170
|
| "dataTableColProperties"
|
|
11171
|
+
| "dataTableColRenderer"
|
|
10932
11172
|
| "dataTableColWidth"
|
|
10933
11173
|
| "dataTableColorTransparency"
|
|
10934
11174
|
| "dataTableColored"
|
|
11175
|
+
| "dataTableFitHeight"
|
|
11176
|
+
| "dataTableFitWidth"
|
|
10935
11177
|
| "dataTableGrouped"
|
|
10936
11178
|
| "dataTableHeaderBackgroundColor"
|
|
11179
|
+
| "dataTableHeaderIcons"
|
|
10937
11180
|
| "dataTableHeaderTemplate"
|
|
10938
11181
|
| "dataTableHeaderTextAlign"
|
|
10939
11182
|
| "dataTableHeaderTextBaseline"
|
|
@@ -11088,6 +11331,7 @@ declare namespace CanvasXpress {
|
|
|
11088
11331
|
| "dotplotType";
|
|
11089
11332
|
/** Config keys in the "Dumbbell Graphs" category. */
|
|
11090
11333
|
export type CXKeysDumbbellGraphs =
|
|
11334
|
+
| "dumbbellArrowDirection"
|
|
11091
11335
|
| "dumbbellType";
|
|
11092
11336
|
/** Config keys in the "Error Bars" category. */
|
|
11093
11337
|
export type CXKeysErrorBars =
|
|
@@ -11491,6 +11735,7 @@ declare namespace CanvasXpress {
|
|
|
11491
11735
|
| "lineDecoration"
|
|
11492
11736
|
| "lineErrorType"
|
|
11493
11737
|
| "lineType"
|
|
11738
|
+
| "showLineEndLabels"
|
|
11494
11739
|
| "tension"
|
|
11495
11740
|
| "tensionSegments";
|
|
11496
11741
|
/** Config keys in the "Lines" category. */
|
|
@@ -11539,16 +11784,20 @@ declare namespace CanvasXpress {
|
|
|
11539
11784
|
/** Config keys in the "Maps" category. */
|
|
11540
11785
|
export type CXKeysMaps =
|
|
11541
11786
|
| "hiddenMapFeatures"
|
|
11787
|
+
| "mapBubbleColor"
|
|
11542
11788
|
| "mapColor"
|
|
11543
11789
|
| "mapConfig"
|
|
11544
11790
|
| "mapConfigFeatures"
|
|
11545
11791
|
| "mapId"
|
|
11792
|
+
| "mapLabelColor"
|
|
11793
|
+
| "mapLabelProperty"
|
|
11546
11794
|
| "mapMarkerShape"
|
|
11547
11795
|
| "mapMarkerShapeScaleFactor"
|
|
11548
11796
|
| "mapOutlineColor"
|
|
11549
11797
|
| "mapProjection"
|
|
11550
11798
|
| "mapSmps"
|
|
11551
11799
|
| "mapZipCodeIds"
|
|
11800
|
+
| "showMapLabels"
|
|
11552
11801
|
| "topoJSON"
|
|
11553
11802
|
| "visibleMapFeatures";
|
|
11554
11803
|
/** Config keys in the "Maps Albers" category. */
|
|
@@ -11781,6 +12030,7 @@ declare namespace CanvasXpress {
|
|
|
11781
12030
|
| "pieSegmentLabels"
|
|
11782
12031
|
| "pieSegmentPrecision"
|
|
11783
12032
|
| "pieSegmentSeparation"
|
|
12033
|
+
| "pieShape"
|
|
11784
12034
|
| "pieType"
|
|
11785
12035
|
| "showPieSampleLabel"
|
|
11786
12036
|
| "showPieValues"
|
|
@@ -11816,7 +12066,8 @@ declare namespace CanvasXpress {
|
|
|
11816
12066
|
| "isCxplot"
|
|
11817
12067
|
| "isDataFrame"
|
|
11818
12068
|
| "isGGMatrix"
|
|
11819
|
-
| "isR"
|
|
12069
|
+
| "isR"
|
|
12070
|
+
| "responsiveRules";
|
|
11820
12071
|
/** Config keys in the "Plot Mode" category. */
|
|
11821
12072
|
export type CXKeysPlotMode =
|
|
11822
12073
|
| "isEditable"
|
|
@@ -11883,6 +12134,7 @@ declare namespace CanvasXpress {
|
|
|
11883
12134
|
| "rAxisLogTicksShow"
|
|
11884
12135
|
| "rAxisLogTicksTransparency"
|
|
11885
12136
|
| "rAxisLogTicksWidth"
|
|
12137
|
+
| "rAxisNumberFormat"
|
|
11886
12138
|
| "rAxisPercentShow"
|
|
11887
12139
|
| "rAxisSetLabels"
|
|
11888
12140
|
| "rAxisSetMinorValues"
|
|
@@ -12087,6 +12339,7 @@ declare namespace CanvasXpress {
|
|
|
12087
12339
|
| "align"
|
|
12088
12340
|
| "autoScaleFont"
|
|
12089
12341
|
| "baseline"
|
|
12342
|
+
| "dataLabelNumberFormat"
|
|
12090
12343
|
| "fontColor"
|
|
12091
12344
|
| "fontName"
|
|
12092
12345
|
| "fontScaleFontFactor"
|
|
@@ -12094,8 +12347,11 @@ declare namespace CanvasXpress {
|
|
|
12094
12347
|
| "fontStyle"
|
|
12095
12348
|
| "fonts"
|
|
12096
12349
|
| "fontsExternal"
|
|
12350
|
+
| "legendNumberFormat"
|
|
12097
12351
|
| "maxTextSize"
|
|
12098
|
-
| "minTextSize"
|
|
12352
|
+
| "minTextSize"
|
|
12353
|
+
| "numberFormat"
|
|
12354
|
+
| "tooltipNumberFormat";
|
|
12099
12355
|
/** Config keys in the "Text Placement" category. */
|
|
12100
12356
|
export type CXKeysTextPlacement =
|
|
12101
12357
|
| "optimizeTextPosition"
|
|
@@ -12105,6 +12361,7 @@ declare namespace CanvasXpress {
|
|
|
12105
12361
|
| "optimizeTextPositionTemperature";
|
|
12106
12362
|
/** Config keys in the "Titles and Subtitles" category. */
|
|
12107
12363
|
export type CXKeysTitlesandSubtitles =
|
|
12364
|
+
| "a11yDescription"
|
|
12108
12365
|
| "subtitle"
|
|
12109
12366
|
| "subtitleAlign"
|
|
12110
12367
|
| "subtitleBaseline"
|
|
@@ -12256,6 +12513,7 @@ declare namespace CanvasXpress {
|
|
|
12256
12513
|
| "setPanningMinX"
|
|
12257
12514
|
| "xAxis"
|
|
12258
12515
|
| "xAxis2"
|
|
12516
|
+
| "xAxis2NumberFormat"
|
|
12259
12517
|
| "xAxis2Rotate"
|
|
12260
12518
|
| "xAxis2Show"
|
|
12261
12519
|
| "xAxis2TickFormat"
|
|
@@ -12295,6 +12553,7 @@ declare namespace CanvasXpress {
|
|
|
12295
12553
|
| "xAxisLogTicksTransparency"
|
|
12296
12554
|
| "xAxisLogTicksWidth"
|
|
12297
12555
|
| "xAxisMinorTicks"
|
|
12556
|
+
| "xAxisNumberFormat"
|
|
12298
12557
|
| "xAxisRugHeight"
|
|
12299
12558
|
| "xAxisRugPosition"
|
|
12300
12559
|
| "xAxisRugShow"
|
|
@@ -12376,6 +12635,7 @@ declare namespace CanvasXpress {
|
|
|
12376
12635
|
| "yAxisLogTicksTransparency"
|
|
12377
12636
|
| "yAxisLogTicksWidth"
|
|
12378
12637
|
| "yAxisMinorTicks"
|
|
12638
|
+
| "yAxisNumberFormat"
|
|
12379
12639
|
| "yAxisRugHeight"
|
|
12380
12640
|
| "yAxisRugPosition"
|
|
12381
12641
|
| "yAxisRugShow"
|
|
@@ -12440,6 +12700,7 @@ declare namespace CanvasXpress {
|
|
|
12440
12700
|
| "zAxisLogTicksShow"
|
|
12441
12701
|
| "zAxisLogTicksTransparency"
|
|
12442
12702
|
| "zAxisLogTicksWidth"
|
|
12703
|
+
| "zAxisNumberFormat"
|
|
12443
12704
|
| "zAxisSetLabels"
|
|
12444
12705
|
| "zAxisSetMinorValues"
|
|
12445
12706
|
| "zAxisSetValues"
|