canvasxpress 69.0.0 → 69.2.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.d.mts +37 -2
- package/src/canvasXpress.d.ts +37 -2
- package/src/canvasXpress.js +3 -3
package/package.json
CHANGED
package/src/canvasXpress.d.mts
CHANGED
|
@@ -122,7 +122,7 @@ export type CXGraphType =
|
|
|
122
122
|
|
|
123
123
|
/**
|
|
124
124
|
* Full chart configuration — one property per parameter in the CanvasXpress
|
|
125
|
-
* config schema (
|
|
125
|
+
* config schema (1691 keys). String enums become open literal
|
|
126
126
|
* unions (except `graphType`, which is closed); `@graphTypes` in a key's JSDoc
|
|
127
127
|
* lists the graph types it applies to (absent = all). The index signature keeps
|
|
128
128
|
* obfuscation aliases and any newer key valid. See `CXConfigFor<G>` for the
|
|
@@ -4044,12 +4044,27 @@ export interface CXConfig {
|
|
|
4044
4044
|
* @default "symbol"
|
|
4045
4045
|
*/
|
|
4046
4046
|
lineDecoration?: string | boolean;
|
|
4047
|
+
/**
|
|
4048
|
+
* Name of the attribute to set the line style (solid, dashed, dotted, etc.) of the edges
|
|
4049
|
+
* @graphTypes Network
|
|
4050
|
+
* @default false
|
|
4051
|
+
*/
|
|
4052
|
+
lineEdgeBy?: string | boolean;
|
|
4047
4053
|
/**
|
|
4048
4054
|
* Line error type in the line graphs. The line type must be spline for the area error type.
|
|
4049
4055
|
* @graphTypes Area, AreaLine, BarLine, DotLine, Line, ParallelCoordinates … (9 types; see CXGraphTypeKeys)
|
|
4050
4056
|
* @default "bar"
|
|
4051
4057
|
*/
|
|
4052
4058
|
lineErrorType?: "bar" | "area" | false | (string & {});
|
|
4059
|
+
/**
|
|
4060
|
+
* Object to assign custom line styles (solid, dashed, dotted, dotdash, longdash, twodash) to
|
|
4061
|
+
* the levels of a Network edge attribute used with lineEdgeBy. The key of the object is a
|
|
4062
|
+
* value of the attribute; a default line style will be assigned to any value not included in
|
|
4063
|
+
* the object
|
|
4064
|
+
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
4065
|
+
* @default false
|
|
4066
|
+
*/
|
|
4067
|
+
lineKey?: Record<string, unknown> | boolean;
|
|
4053
4068
|
/**
|
|
4054
4069
|
* Line Patterns used in line visualizations
|
|
4055
4070
|
* @default ["solid","dotted","dashed","dotdash","longdash","twodash"]
|
|
@@ -7133,6 +7148,12 @@ export interface CXConfig {
|
|
|
7133
7148
|
* @default true
|
|
7134
7149
|
*/
|
|
7135
7150
|
showLegendTitle?: boolean;
|
|
7151
|
+
/**
|
|
7152
|
+
* Flag to show/hide the legend edge line style
|
|
7153
|
+
* @graphTypes Bar, BarLine, Boxplot, Bullet, Cleveland, DotLine … (19 types; see CXGraphTypeKeys)
|
|
7154
|
+
* @default true
|
|
7155
|
+
*/
|
|
7156
|
+
showLineEdgeLegend?: boolean;
|
|
7136
7157
|
/**
|
|
7137
7158
|
* Flag to show/hide the legend line
|
|
7138
7159
|
* @graphTypes Bar, BarLine, Boxplot, Bullet, Cleveland, DotLine … (19 types; see CXGraphTypeKeys)
|
|
@@ -8777,6 +8798,16 @@ export interface CXConfig {
|
|
|
8777
8798
|
* @default "rgb(153,153,153)"
|
|
8778
8799
|
*/
|
|
8779
8800
|
waterfallNetColor?: string | boolean;
|
|
8801
|
+
/**
|
|
8802
|
+
* Name of a sample annotation (data.x) or variable (data.y.vars) whose per-sample value
|
|
8803
|
+
* weighs that sample in count-type summaries: Meter count/countTotal, the meterProgress ring
|
|
8804
|
+
* (selected/total by weight) and pieBy slices. Default false weighs every sample 1, a plain
|
|
8805
|
+
* count. The dual of grouping: it expands one sample into many without materializing them (R
|
|
8806
|
+
* count(wt=), ggplot aes(weight=))
|
|
8807
|
+
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
8808
|
+
* @default false
|
|
8809
|
+
*/
|
|
8810
|
+
weightBy?: string | boolean;
|
|
8780
8811
|
/**
|
|
8781
8812
|
* Color for the accent elements in all the UI widgets. It only applied if the dataUIStyle is
|
|
8782
8813
|
* set to false
|
|
@@ -10649,7 +10680,8 @@ export type CXKeysData =
|
|
|
10649
10680
|
| "groupingFactors"
|
|
10650
10681
|
| "groupingFactorsLabelsHide"
|
|
10651
10682
|
| "summaryType"
|
|
10652
|
-
| "transposeData"
|
|
10683
|
+
| "transposeData"
|
|
10684
|
+
| "weightBy";
|
|
10653
10685
|
/** Config keys in the "Data Context" category. */
|
|
10654
10686
|
export type CXKeysDataContext =
|
|
10655
10687
|
| "asSampleFactors"
|
|
@@ -10722,6 +10754,7 @@ export type CXKeysDataPointAttributes =
|
|
|
10722
10754
|
| "labelBy"
|
|
10723
10755
|
| "labelSelect"
|
|
10724
10756
|
| "lineBy"
|
|
10757
|
+
| "lineKey"
|
|
10725
10758
|
| "markerBy"
|
|
10726
10759
|
| "outlineBy"
|
|
10727
10760
|
| "outlineByData"
|
|
@@ -11337,6 +11370,7 @@ export type CXKeysLegends =
|
|
|
11337
11370
|
| "showLegend"
|
|
11338
11371
|
| "showLegendBorder"
|
|
11339
11372
|
| "showLegendTitle"
|
|
11373
|
+
| "showLineEdgeLegend"
|
|
11340
11374
|
| "showLineLegend"
|
|
11341
11375
|
| "showOutlineLegend"
|
|
11342
11376
|
| "showPatternLegend"
|
|
@@ -11574,6 +11608,7 @@ export type CXKeysNetworkGraphs =
|
|
|
11574
11608
|
export type CXKeysNetworkNodeandEdgeAttributes =
|
|
11575
11609
|
| "colorEdgeBy"
|
|
11576
11610
|
| "colorNodeBy"
|
|
11611
|
+
| "lineEdgeBy"
|
|
11577
11612
|
| "maxEdgeSize"
|
|
11578
11613
|
| "minEdgeSize"
|
|
11579
11614
|
| "patternNodeBy"
|
package/src/canvasXpress.d.ts
CHANGED
|
@@ -131,7 +131,7 @@ declare namespace CanvasXpress {
|
|
|
131
131
|
|
|
132
132
|
/**
|
|
133
133
|
* Full chart configuration — one property per parameter in the CanvasXpress
|
|
134
|
-
* config schema (
|
|
134
|
+
* config schema (1691 keys). String enums become open literal
|
|
135
135
|
* unions (except `graphType`, which is closed); `@graphTypes` in a key's JSDoc
|
|
136
136
|
* lists the graph types it applies to (absent = all). The index signature keeps
|
|
137
137
|
* obfuscation aliases and any newer key valid. See `CXConfigFor<G>` for the
|
|
@@ -4053,12 +4053,27 @@ declare namespace CanvasXpress {
|
|
|
4053
4053
|
* @default "symbol"
|
|
4054
4054
|
*/
|
|
4055
4055
|
lineDecoration?: string | boolean;
|
|
4056
|
+
/**
|
|
4057
|
+
* Name of the attribute to set the line style (solid, dashed, dotted, etc.) of the edges
|
|
4058
|
+
* @graphTypes Network
|
|
4059
|
+
* @default false
|
|
4060
|
+
*/
|
|
4061
|
+
lineEdgeBy?: string | boolean;
|
|
4056
4062
|
/**
|
|
4057
4063
|
* Line error type in the line graphs. The line type must be spline for the area error type.
|
|
4058
4064
|
* @graphTypes Area, AreaLine, BarLine, DotLine, Line, ParallelCoordinates … (9 types; see CXGraphTypeKeys)
|
|
4059
4065
|
* @default "bar"
|
|
4060
4066
|
*/
|
|
4061
4067
|
lineErrorType?: "bar" | "area" | false | (string & {});
|
|
4068
|
+
/**
|
|
4069
|
+
* Object to assign custom line styles (solid, dashed, dotted, dotdash, longdash, twodash) to
|
|
4070
|
+
* the levels of a Network edge attribute used with lineEdgeBy. The key of the object is a
|
|
4071
|
+
* value of the attribute; a default line style will be assigned to any value not included in
|
|
4072
|
+
* the object
|
|
4073
|
+
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
4074
|
+
* @default false
|
|
4075
|
+
*/
|
|
4076
|
+
lineKey?: Record<string, unknown> | boolean;
|
|
4062
4077
|
/**
|
|
4063
4078
|
* Line Patterns used in line visualizations
|
|
4064
4079
|
* @default ["solid","dotted","dashed","dotdash","longdash","twodash"]
|
|
@@ -7142,6 +7157,12 @@ declare namespace CanvasXpress {
|
|
|
7142
7157
|
* @default true
|
|
7143
7158
|
*/
|
|
7144
7159
|
showLegendTitle?: boolean;
|
|
7160
|
+
/**
|
|
7161
|
+
* Flag to show/hide the legend edge line style
|
|
7162
|
+
* @graphTypes Bar, BarLine, Boxplot, Bullet, Cleveland, DotLine … (19 types; see CXGraphTypeKeys)
|
|
7163
|
+
* @default true
|
|
7164
|
+
*/
|
|
7165
|
+
showLineEdgeLegend?: boolean;
|
|
7145
7166
|
/**
|
|
7146
7167
|
* Flag to show/hide the legend line
|
|
7147
7168
|
* @graphTypes Bar, BarLine, Boxplot, Bullet, Cleveland, DotLine … (19 types; see CXGraphTypeKeys)
|
|
@@ -8786,6 +8807,16 @@ declare namespace CanvasXpress {
|
|
|
8786
8807
|
* @default "rgb(153,153,153)"
|
|
8787
8808
|
*/
|
|
8788
8809
|
waterfallNetColor?: string | boolean;
|
|
8810
|
+
/**
|
|
8811
|
+
* Name of a sample annotation (data.x) or variable (data.y.vars) whose per-sample value
|
|
8812
|
+
* weighs that sample in count-type summaries: Meter count/countTotal, the meterProgress ring
|
|
8813
|
+
* (selected/total by weight) and pieBy slices. Default false weighs every sample 1, a plain
|
|
8814
|
+
* count. The dual of grouping: it expands one sample into many without materializing them (R
|
|
8815
|
+
* count(wt=), ggplot aes(weight=))
|
|
8816
|
+
* @graphTypes Alluvial, Area, AreaLine, Bar, BarLine, Boxplot … (65 types; see CXGraphTypeKeys)
|
|
8817
|
+
* @default false
|
|
8818
|
+
*/
|
|
8819
|
+
weightBy?: string | boolean;
|
|
8789
8820
|
/**
|
|
8790
8821
|
* Color for the accent elements in all the UI widgets. It only applied if the dataUIStyle is
|
|
8791
8822
|
* set to false
|
|
@@ -10658,7 +10689,8 @@ declare namespace CanvasXpress {
|
|
|
10658
10689
|
| "groupingFactors"
|
|
10659
10690
|
| "groupingFactorsLabelsHide"
|
|
10660
10691
|
| "summaryType"
|
|
10661
|
-
| "transposeData"
|
|
10692
|
+
| "transposeData"
|
|
10693
|
+
| "weightBy";
|
|
10662
10694
|
/** Config keys in the "Data Context" category. */
|
|
10663
10695
|
export type CXKeysDataContext =
|
|
10664
10696
|
| "asSampleFactors"
|
|
@@ -10731,6 +10763,7 @@ declare namespace CanvasXpress {
|
|
|
10731
10763
|
| "labelBy"
|
|
10732
10764
|
| "labelSelect"
|
|
10733
10765
|
| "lineBy"
|
|
10766
|
+
| "lineKey"
|
|
10734
10767
|
| "markerBy"
|
|
10735
10768
|
| "outlineBy"
|
|
10736
10769
|
| "outlineByData"
|
|
@@ -11346,6 +11379,7 @@ declare namespace CanvasXpress {
|
|
|
11346
11379
|
| "showLegend"
|
|
11347
11380
|
| "showLegendBorder"
|
|
11348
11381
|
| "showLegendTitle"
|
|
11382
|
+
| "showLineEdgeLegend"
|
|
11349
11383
|
| "showLineLegend"
|
|
11350
11384
|
| "showOutlineLegend"
|
|
11351
11385
|
| "showPatternLegend"
|
|
@@ -11583,6 +11617,7 @@ declare namespace CanvasXpress {
|
|
|
11583
11617
|
export type CXKeysNetworkNodeandEdgeAttributes =
|
|
11584
11618
|
| "colorEdgeBy"
|
|
11585
11619
|
| "colorNodeBy"
|
|
11620
|
+
| "lineEdgeBy"
|
|
11586
11621
|
| "maxEdgeSize"
|
|
11587
11622
|
| "minEdgeSize"
|
|
11588
11623
|
| "patternNodeBy"
|