@visactor/vchart-schema 2.0.11-alpha.8 → 2.0.11

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.
Files changed (2) hide show
  1. package/package.json +3 -3
  2. package/vchart.json +190 -40
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@visactor/vchart-schema",
3
- "version": "2.0.11-alpha.8",
3
+ "version": "2.0.11",
4
4
  "description": "The VChart JSON schema file.",
5
5
  "sideEffects": false,
6
6
  "main": "vchart.json",
@@ -19,8 +19,8 @@
19
19
  "jest-electron": "^0.1.12",
20
20
  "ts-jest": "^26.0.0",
21
21
  "@types/semver": "7.3.12",
22
- "@internal/ts-config": "0.0.1",
23
- "@internal/eslint-config": "0.0.1"
22
+ "@internal/eslint-config": "0.0.1",
23
+ "@internal/ts-config": "0.0.1"
24
24
  },
25
25
  "homepage": "",
26
26
  "bugs": "https://github.com/VisActor/VChart/issues",
package/vchart.json CHANGED
@@ -1835,13 +1835,24 @@
1835
1835
  "$ref": "#/definitions/VisualType<\"accurate\"|\"imprecise\">",
1836
1836
  "description": "bounds的计算模式"
1837
1837
  },
1838
- "boxFill": {
1838
+ "boxCornerRadius": {
1839
+ "$ref": "#/definitions/VisualType<number>",
1840
+ "description": "箱体的圆角半径\n在 shaftShape = 'line' / 'filled-line' 模式下,控制 box 子图元的 cornerRadius 属性",
1841
+ "since": "2.0.11"
1842
+ },
1843
+ "boxHeight": {
1844
+ "$ref": "#/definitions/VisualType<string|number>",
1845
+ "description": "箱体的高度(垂直箱线图)或宽度(水平箱线图)\n在 shaftShape = 'line' / 'filled-line' 模式下使用"
1846
+ },
1847
+ "boxStroke": {
1839
1848
  "$ref": "#/definitions/VisualType<string>",
1840
- "description": "盒子填充颜色,为空则不填充"
1849
+ "description": "箱体的描边颜色\n在 shaftShape = 'line' / 'filled-line' 模式下,控制 box 子图元的 stroke 属性",
1850
+ "since": "2.0.11"
1841
1851
  },
1842
1852
  "boxWidth": {
1843
1853
  "$ref": "#/definitions/VisualType<string|number>",
1844
- "description": "box宽度"
1854
+ "default": 30,
1855
+ "description": "箱体的宽度(垂直箱线图)或高度(水平箱线图)\n在 shaftShape = 'line' / 'filled-line' 模式下,控制 box 子图元的尺寸\n支持像素值或百分比字符串(相对于分组宽度)"
1845
1856
  },
1846
1857
  "cursor": {
1847
1858
  "$ref": "#/definitions/VisualType<Cursor>",
@@ -1866,19 +1877,37 @@
1866
1877
  },
1867
1878
  "lineWidth": {
1868
1879
  "$ref": "#/definitions/VisualType<number>",
1869
- "description": "box描边宽度"
1880
+ "default": 2,
1881
+ "description": "箱线图的描边宽度\n在 shaftShape = 'line' / 'filled-line' 模式下影响所有线条的宽度\n在 shaftShape = 'bar' 模式下,minMaxBox 和 q1q3Box 的 lineWidth 会被强制设为 0"
1870
1882
  },
1871
1883
  "max": {
1872
1884
  "$ref": "#/definitions/VisualType<(datum:Datum)=>number>_4",
1873
- "description": "最大值"
1885
+ "description": "最大值(箱线图的上限)\n用于计算箱线图的上端须线位置"
1874
1886
  },
1875
1887
  "median": {
1876
1888
  "$ref": "#/definitions/VisualType<(datum:Datum)=>number>_2",
1877
- "description": "中位数"
1889
+ "description": "中位数(Q2,50%分位数)\n在箱体中绘制中位数线"
1890
+ },
1891
+ "medianStroke": {
1892
+ "$ref": "#/definitions/VisualType<string>",
1893
+ "description": "中位数线的描边颜色\n在 shaftShape = 'line' / 'filled-line' 模式下,控制 median 子图元的 stroke 属性",
1894
+ "since": "2.0.11"
1878
1895
  },
1879
1896
  "min": {
1880
1897
  "$ref": "#/definitions/VisualType<(datum:Datum)=>number>",
1881
- "description": "最小值"
1898
+ "description": "最小值(箱线图的下限)\n用于计算箱线图的下端须线位置"
1899
+ },
1900
+ "minMaxFillOpacity": {
1901
+ "$ref": "#/definitions/VisualType<number>",
1902
+ "description": "最小-最大值矩形的填充透明度\n仅在 shaftShape = 'bar' 模式下生效,控制 minMaxBox 子图元的 fillOpacity"
1903
+ },
1904
+ "minMaxHeight": {
1905
+ "$ref": "#/definitions/VisualType<string|number>",
1906
+ "description": "最小-最大值矩形的高度(垂直箱线图)或宽度(水平箱线图)\n在 shaftShape = 'bar' 模式下使用"
1907
+ },
1908
+ "minMaxWidth": {
1909
+ "$ref": "#/definitions/VisualType<string|number>",
1910
+ "description": "最小-最大值矩形的宽度(垂直箱线图)或高度(水平箱线图)\n在 shaftShape = 'bar' 模式下,控制 minMaxBox 子图元的尺寸"
1882
1911
  },
1883
1912
  "opacity": {
1884
1913
  "$ref": "#/definitions/VisualType<number>",
@@ -1900,11 +1929,27 @@
1900
1929
  },
1901
1930
  "q1": {
1902
1931
  "$ref": "#/definitions/VisualType<(datum:Datum)=>number>_1",
1903
- "description": "25%分位数"
1932
+ "description": "第一四分位数(Q1,25%分位数)\n用于确定箱体的下边界"
1933
+ },
1934
+ "q1q3Height": {
1935
+ "$ref": "#/definitions/VisualType<string|number>",
1936
+ "description": "Q1-Q3 四分位数矩形的高度(垂直箱线图)或宽度(水平箱线图)\n在 shaftShape = 'bar' 模式下使用"
1937
+ },
1938
+ "q1q3Width": {
1939
+ "$ref": "#/definitions/VisualType<string|number>",
1940
+ "description": "Q1-Q3 四分位数矩形的宽度(垂直箱线图)或高度(水平箱线图)\n在 shaftShape = 'bar' 模式下,控制 q1q3Box 子图元的尺寸"
1904
1941
  },
1905
1942
  "q3": {
1906
1943
  "$ref": "#/definitions/VisualType<(datum:Datum)=>number>_3",
1907
- "description": "75%分位数"
1944
+ "description": "第三四分位数(Q3,75%分位数)\n用于确定箱体的上边界"
1945
+ },
1946
+ "ruleHeight": {
1947
+ "$ref": "#/definitions/VisualType<string|number>",
1948
+ "description": "最大/最小值须线端点的高度(垂直箱线图)或宽度(水平箱线图)\n在 shaftShape = 'line' / 'filled-line' 模式下使用"
1949
+ },
1950
+ "ruleWidth": {
1951
+ "$ref": "#/definitions/VisualType<string|number>",
1952
+ "description": "最大/最小值须线端点的宽度(垂直箱线图)或高度(水平箱线图)\n在 shaftShape = 'line' / 'filled-line' 模式下使用"
1908
1953
  },
1909
1954
  "scaleCenter": {
1910
1955
  "$ref": "#/definitions/VisualType<[string|number,string|number]>",
@@ -1919,17 +1964,15 @@
1919
1964
  "$ref": "#/definitions/VisualType<number>",
1920
1965
  "description": "y方向的缩放比例,默认为1,即不进行缩放"
1921
1966
  },
1922
- "shaftFillOpacity": {
1923
- "$ref": "#/definitions/VisualType<number>",
1924
- "description": "中轴线透明度,仅当shaftType=bar时生效"
1925
- },
1926
1967
  "shaftShape": {
1927
1968
  "$ref": "#/definitions/VisualType<BoxPlotShaftShape>",
1928
- "description": "中轴线类型"
1969
+ "default": "'line'",
1970
+ "description": "中轴线(须线)的绘制形状\n- 'line': 标准线条形式,绘制 shaft(连接线)、box(箱体)、max/min/median(线条)五个子图元\n- 'bar': 柱状形式,绘制 minMaxBox(最小-最大值矩形)、q1q3Box(Q1-Q3矩形)、median(中位数线)三个子图元\n- 'filled-line': 填充线条形式"
1929
1971
  },
1930
1972
  "shaftWidth": {
1931
1973
  "$ref": "#/definitions/VisualType<string|number>",
1932
- "description": "最大最小值宽度"
1974
+ "default": 20,
1975
+ "description": "最大/最小值须线的宽度(垂直箱线图)或高度(水平箱线图)\n在 shaftShape = 'line' / 'filled-line' 模式下,控制 max/min 子图元的线条长度\n支持像素值或百分比字符串"
1933
1976
  },
1934
1977
  "stroke": {
1935
1978
  "$ref": "#/definitions/VisualType<string|false|IColorKey|IGradient|(number|boolean)[]>",
@@ -2005,13 +2048,24 @@
2005
2048
  "$ref": "#/definitions/VisualType<\"accurate\"|\"imprecise\">",
2006
2049
  "description": "bounds的计算模式"
2007
2050
  },
2008
- "boxFill": {
2051
+ "boxCornerRadius": {
2052
+ "$ref": "#/definitions/VisualType<number>",
2053
+ "description": "箱体的圆角半径\n在 shaftShape = 'line' / 'filled-line' 模式下,控制 box 子图元的 cornerRadius 属性",
2054
+ "since": "2.0.11"
2055
+ },
2056
+ "boxHeight": {
2057
+ "$ref": "#/definitions/VisualType<string|number>",
2058
+ "description": "箱体的高度(垂直箱线图)或宽度(水平箱线图)\n在 shaftShape = 'line' / 'filled-line' 模式下使用"
2059
+ },
2060
+ "boxStroke": {
2009
2061
  "$ref": "#/definitions/VisualType<string>",
2010
- "description": "盒子填充颜色,为空则不填充"
2062
+ "description": "箱体的描边颜色\n在 shaftShape = 'line' / 'filled-line' 模式下,控制 box 子图元的 stroke 属性",
2063
+ "since": "2.0.11"
2011
2064
  },
2012
2065
  "boxWidth": {
2013
2066
  "$ref": "#/definitions/VisualType<string|number>",
2014
- "description": "box宽度"
2067
+ "default": 30,
2068
+ "description": "箱体的宽度(垂直箱线图)或高度(水平箱线图)\n在 shaftShape = 'line' / 'filled-line' 模式下,控制 box 子图元的尺寸\n支持像素值或百分比字符串(相对于分组宽度)"
2015
2069
  },
2016
2070
  "cursor": {
2017
2071
  "$ref": "#/definitions/VisualType<Cursor>",
@@ -2036,19 +2090,37 @@
2036
2090
  },
2037
2091
  "lineWidth": {
2038
2092
  "$ref": "#/definitions/VisualType<number>",
2039
- "description": "box描边宽度"
2093
+ "default": 2,
2094
+ "description": "箱线图的描边宽度\n在 shaftShape = 'line' / 'filled-line' 模式下影响所有线条的宽度\n在 shaftShape = 'bar' 模式下,minMaxBox 和 q1q3Box 的 lineWidth 会被强制设为 0"
2040
2095
  },
2041
2096
  "max": {
2042
2097
  "$ref": "#/definitions/VisualType<(datum:Datum)=>number>_4",
2043
- "description": "最大值"
2098
+ "description": "最大值(箱线图的上限)\n用于计算箱线图的上端须线位置"
2044
2099
  },
2045
2100
  "median": {
2046
2101
  "$ref": "#/definitions/VisualType<(datum:Datum)=>number>_2",
2047
- "description": "中位数"
2102
+ "description": "中位数(Q2,50%分位数)\n在箱体中绘制中位数线"
2103
+ },
2104
+ "medianStroke": {
2105
+ "$ref": "#/definitions/VisualType<string>",
2106
+ "description": "中位数线的描边颜色\n在 shaftShape = 'line' / 'filled-line' 模式下,控制 median 子图元的 stroke 属性",
2107
+ "since": "2.0.11"
2048
2108
  },
2049
2109
  "min": {
2050
2110
  "$ref": "#/definitions/VisualType<(datum:Datum)=>number>",
2051
- "description": "最小值"
2111
+ "description": "最小值(箱线图的下限)\n用于计算箱线图的下端须线位置"
2112
+ },
2113
+ "minMaxFillOpacity": {
2114
+ "$ref": "#/definitions/VisualType<number>",
2115
+ "description": "最小-最大值矩形的填充透明度\n仅在 shaftShape = 'bar' 模式下生效,控制 minMaxBox 子图元的 fillOpacity"
2116
+ },
2117
+ "minMaxHeight": {
2118
+ "$ref": "#/definitions/VisualType<string|number>",
2119
+ "description": "最小-最大值矩形的高度(垂直箱线图)或宽度(水平箱线图)\n在 shaftShape = 'bar' 模式下使用"
2120
+ },
2121
+ "minMaxWidth": {
2122
+ "$ref": "#/definitions/VisualType<string|number>",
2123
+ "description": "最小-最大值矩形的宽度(垂直箱线图)或高度(水平箱线图)\n在 shaftShape = 'bar' 模式下,控制 minMaxBox 子图元的尺寸"
2052
2124
  },
2053
2125
  "opacity": {
2054
2126
  "$ref": "#/definitions/VisualType<number>",
@@ -2070,11 +2142,27 @@
2070
2142
  },
2071
2143
  "q1": {
2072
2144
  "$ref": "#/definitions/VisualType<(datum:Datum)=>number>_1",
2073
- "description": "25%分位数"
2145
+ "description": "第一四分位数(Q1,25%分位数)\n用于确定箱体的下边界"
2146
+ },
2147
+ "q1q3Height": {
2148
+ "$ref": "#/definitions/VisualType<string|number>",
2149
+ "description": "Q1-Q3 四分位数矩形的高度(垂直箱线图)或宽度(水平箱线图)\n在 shaftShape = 'bar' 模式下使用"
2150
+ },
2151
+ "q1q3Width": {
2152
+ "$ref": "#/definitions/VisualType<string|number>",
2153
+ "description": "Q1-Q3 四分位数矩形的宽度(垂直箱线图)或高度(水平箱线图)\n在 shaftShape = 'bar' 模式下,控制 q1q3Box 子图元的尺寸"
2074
2154
  },
2075
2155
  "q3": {
2076
2156
  "$ref": "#/definitions/VisualType<(datum:Datum)=>number>_3",
2077
- "description": "75%分位数"
2157
+ "description": "第三四分位数(Q3,75%分位数)\n用于确定箱体的上边界"
2158
+ },
2159
+ "ruleHeight": {
2160
+ "$ref": "#/definitions/VisualType<string|number>",
2161
+ "description": "最大/最小值须线端点的高度(垂直箱线图)或宽度(水平箱线图)\n在 shaftShape = 'line' / 'filled-line' 模式下使用"
2162
+ },
2163
+ "ruleWidth": {
2164
+ "$ref": "#/definitions/VisualType<string|number>",
2165
+ "description": "最大/最小值须线端点的宽度(垂直箱线图)或高度(水平箱线图)\n在 shaftShape = 'line' / 'filled-line' 模式下使用"
2078
2166
  },
2079
2167
  "scaleCenter": {
2080
2168
  "$ref": "#/definitions/VisualType<[string|number,string|number]>",
@@ -2089,17 +2177,15 @@
2089
2177
  "$ref": "#/definitions/VisualType<number>",
2090
2178
  "description": "y方向的缩放比例,默认为1,即不进行缩放"
2091
2179
  },
2092
- "shaftFillOpacity": {
2093
- "$ref": "#/definitions/VisualType<number>",
2094
- "description": "中轴线透明度,仅当shaftType=bar时生效"
2095
- },
2096
2180
  "shaftShape": {
2097
2181
  "$ref": "#/definitions/VisualType<BoxPlotShaftShape>",
2098
- "description": "中轴线类型"
2182
+ "default": "'line'",
2183
+ "description": "中轴线(须线)的绘制形状\n- 'line': 标准线条形式,绘制 shaft(连接线)、box(箱体)、max/min/median(线条)五个子图元\n- 'bar': 柱状形式,绘制 minMaxBox(最小-最大值矩形)、q1q3Box(Q1-Q3矩形)、median(中位数线)三个子图元\n- 'filled-line': 填充线条形式"
2099
2184
  },
2100
2185
  "shaftWidth": {
2101
2186
  "$ref": "#/definitions/VisualType<string|number>",
2102
- "description": "最大最小值宽度"
2187
+ "default": 20,
2188
+ "description": "最大/最小值须线的宽度(垂直箱线图)或高度(水平箱线图)\n在 shaftShape = 'line' / 'filled-line' 模式下,控制 max/min 子图元的线条长度\n支持像素值或百分比字符串"
2103
2189
  },
2104
2190
  "stroke": {
2105
2191
  "$ref": "#/definitions/VisualType<string|false|IColorKey|IGradient|(number|boolean)[]>",
@@ -23296,12 +23382,26 @@
23296
23382
  ],
23297
23383
  "type": "string"
23298
23384
  },
23299
- "boxFill": {
23300
- "description": "盒子填充颜色,为空则不填充",
23385
+ "boxCornerRadius": {
23386
+ "description": "箱体的圆角半径\n在 shaftShape = 'line' / 'filled-line' 模式下,控制 box 子图元的 cornerRadius 属性",
23387
+ "since": "2.0.11",
23388
+ "type": "number"
23389
+ },
23390
+ "boxHeight": {
23391
+ "description": "箱体的高度(垂直箱线图)或宽度(水平箱线图)\n在 shaftShape = 'line' / 'filled-line' 模式下使用",
23392
+ "type": [
23393
+ "string",
23394
+ "number"
23395
+ ]
23396
+ },
23397
+ "boxStroke": {
23398
+ "description": "箱体的描边颜色\n在 shaftShape = 'line' / 'filled-line' 模式下,控制 box 子图元的 stroke 属性",
23399
+ "since": "2.0.11",
23301
23400
  "type": "string"
23302
23401
  },
23303
23402
  "boxWidth": {
23304
- "description": "box宽度",
23403
+ "default": 30,
23404
+ "description": "箱体的宽度(垂直箱线图)或高度(水平箱线图)\n在 shaftShape = 'line' / 'filled-line' 模式下,控制 box 子图元的尺寸\n支持像素值或百分比字符串(相对于分组宽度)",
23305
23405
  "type": [
23306
23406
  "string",
23307
23407
  "number"
@@ -23332,7 +23432,8 @@
23332
23432
  "type": "number"
23333
23433
  },
23334
23434
  "lineWidth": {
23335
- "description": "box描边宽度",
23435
+ "default": 2,
23436
+ "description": "箱线图的描边宽度\n在 shaftShape = 'line' / 'filled-line' 模式下影响所有线条的宽度\n在 shaftShape = 'bar' 模式下,minMaxBox 和 q1q3Box 的 lineWidth 会被强制设为 0",
23336
23437
  "type": "number"
23337
23438
  },
23338
23439
  "max": {
@@ -23341,9 +23442,32 @@
23341
23442
  "median": {
23342
23443
  "typeof": "function"
23343
23444
  },
23445
+ "medianStroke": {
23446
+ "description": "中位数线的描边颜色\n在 shaftShape = 'line' / 'filled-line' 模式下,控制 median 子图元的 stroke 属性",
23447
+ "since": "2.0.11",
23448
+ "type": "string"
23449
+ },
23344
23450
  "min": {
23345
23451
  "typeof": "function"
23346
23452
  },
23453
+ "minMaxFillOpacity": {
23454
+ "description": "最小-最大值矩形的填充透明度\n仅在 shaftShape = 'bar' 模式下生效,控制 minMaxBox 子图元的 fillOpacity",
23455
+ "type": "number"
23456
+ },
23457
+ "minMaxHeight": {
23458
+ "description": "最小-最大值矩形的高度(垂直箱线图)或宽度(水平箱线图)\n在 shaftShape = 'bar' 模式下使用",
23459
+ "type": [
23460
+ "string",
23461
+ "number"
23462
+ ]
23463
+ },
23464
+ "minMaxWidth": {
23465
+ "description": "最小-最大值矩形的宽度(垂直箱线图)或高度(水平箱线图)\n在 shaftShape = 'bar' 模式下,控制 minMaxBox 子图元的尺寸",
23466
+ "type": [
23467
+ "string",
23468
+ "number"
23469
+ ]
23470
+ },
23347
23471
  "opacity": {
23348
23472
  "description": "图形的透明度,既影响描边也影响填充",
23349
23473
  "type": "number"
@@ -23370,9 +23494,37 @@
23370
23494
  "q1": {
23371
23495
  "typeof": "function"
23372
23496
  },
23497
+ "q1q3Height": {
23498
+ "description": "Q1-Q3 四分位数矩形的高度(垂直箱线图)或宽度(水平箱线图)\n在 shaftShape = 'bar' 模式下使用",
23499
+ "type": [
23500
+ "string",
23501
+ "number"
23502
+ ]
23503
+ },
23504
+ "q1q3Width": {
23505
+ "description": "Q1-Q3 四分位数矩形的宽度(垂直箱线图)或高度(水平箱线图)\n在 shaftShape = 'bar' 模式下,控制 q1q3Box 子图元的尺寸",
23506
+ "type": [
23507
+ "string",
23508
+ "number"
23509
+ ]
23510
+ },
23373
23511
  "q3": {
23374
23512
  "typeof": "function"
23375
23513
  },
23514
+ "ruleHeight": {
23515
+ "description": "最大/最小值须线端点的高度(垂直箱线图)或宽度(水平箱线图)\n在 shaftShape = 'line' / 'filled-line' 模式下使用",
23516
+ "type": [
23517
+ "string",
23518
+ "number"
23519
+ ]
23520
+ },
23521
+ "ruleWidth": {
23522
+ "description": "最大/最小值须线端点的宽度(垂直箱线图)或高度(水平箱线图)\n在 shaftShape = 'line' / 'filled-line' 模式下使用",
23523
+ "type": [
23524
+ "string",
23525
+ "number"
23526
+ ]
23527
+ },
23376
23528
  "scaleCenter": {
23377
23529
  "description": "图形缩放中心",
23378
23530
  "items": [
@@ -23402,16 +23554,14 @@
23402
23554
  "description": "y方向的缩放比例,默认为1,即不进行缩放",
23403
23555
  "type": "number"
23404
23556
  },
23405
- "shaftFillOpacity": {
23406
- "description": "中轴线透明度,仅当shaftType=bar时生效",
23407
- "type": "number"
23408
- },
23409
23557
  "shaftShape": {
23410
23558
  "$ref": "#/definitions/BoxPlotShaftShape",
23411
- "description": "中轴线类型"
23559
+ "default": "'line'",
23560
+ "description": "中轴线(须线)的绘制形状\n- 'line': 标准线条形式,绘制 shaft(连接线)、box(箱体)、max/min/median(线条)五个子图元\n- 'bar': 柱状形式,绘制 minMaxBox(最小-最大值矩形)、q1q3Box(Q1-Q3矩形)、median(中位数线)三个子图元\n- 'filled-line': 填充线条形式"
23412
23561
  },
23413
23562
  "shaftWidth": {
23414
- "description": "最大最小值宽度",
23563
+ "default": 20,
23564
+ "description": "最大/最小值须线的宽度(垂直箱线图)或高度(水平箱线图)\n在 shaftShape = 'line' / 'filled-line' 模式下,控制 max/min 子图元的线条长度\n支持像素值或百分比字符串",
23415
23565
  "type": [
23416
23566
  "string",
23417
23567
  "number"