@visactor/vseed 0.0.40 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (131) hide show
  1. package/dist/builder/builder/builder.d.ts +61 -671
  2. package/dist/builder/register/chartType/index.d.ts +0 -1
  3. package/dist/dataReshape/constant.d.ts +17 -2
  4. package/dist/dataReshape/dataReshapeByEncoding.d.ts +11 -0
  5. package/dist/dataReshape/index.d.ts +3 -7
  6. package/dist/dataReshape/unfoldDimensions.d.ts +12 -14
  7. package/dist/index.cjs +1184 -1891
  8. package/dist/index.cjs.map +1 -1
  9. package/dist/index.d.ts +1 -1
  10. package/dist/index.js +1106 -1822
  11. package/dist/index.js.map +1 -1
  12. package/dist/pipeline/advanced/chart/pipeline/index.d.ts +0 -1
  13. package/dist/pipeline/advanced/chart/pipes/analysis/index.d.ts +3 -1
  14. package/dist/pipeline/advanced/chart/pipes/analysis/sort.d.ts +0 -4
  15. package/dist/pipeline/advanced/chart/pipes/{encoding/encodingAR.d.ts → analysis/sortLegend.d.ts} +1 -1
  16. package/dist/pipeline/advanced/chart/pipes/analysis/sortXBand.d.ts +3 -0
  17. package/dist/pipeline/advanced/chart/pipes/{encoding/encodingPie.d.ts → analysis/sortYBand.d.ts} +1 -1
  18. package/dist/pipeline/advanced/chart/pipes/encoding/{encodingFunnel.d.ts → bar.d.ts} +1 -1
  19. package/dist/pipeline/advanced/chart/pipes/encoding/{encodingAreaRange.d.ts → column.d.ts} +1 -1
  20. package/dist/pipeline/advanced/chart/pipes/encoding/dualAxis.d.ts +2 -0
  21. package/dist/pipeline/advanced/chart/pipes/encoding/funnel.d.ts +2 -0
  22. package/dist/pipeline/advanced/chart/pipes/encoding/heatmap.d.ts +2 -0
  23. package/dist/pipeline/advanced/chart/pipes/encoding/index.d.ts +8 -9
  24. package/dist/pipeline/advanced/chart/pipes/encoding/{encodingMatrix.d.ts → pie.d.ts} +1 -1
  25. package/dist/pipeline/advanced/chart/pipes/encoding/radar.d.ts +2 -0
  26. package/dist/pipeline/advanced/chart/pipes/encoding/rose.d.ts +2 -0
  27. package/dist/pipeline/advanced/chart/pipes/encoding/scatter.d.ts +2 -0
  28. package/dist/pipeline/advanced/chart/pipes/init/autoScatterMeasures.d.ts +2 -0
  29. package/dist/pipeline/advanced/chart/pipes/init/index.d.ts +2 -1
  30. package/dist/pipeline/advanced/chart/pipes/reshape/index.d.ts +4 -12
  31. package/dist/pipeline/advanced/chart/pipes/reshape/pivotReshapeWithDualEncoding.d.ts +2 -0
  32. package/dist/pipeline/advanced/chart/pipes/reshape/pivotReshapeWithEncoding.d.ts +2 -0
  33. package/dist/pipeline/advanced/chart/pipes/reshape/pivotReshapeWithScatterEncoding.d.ts +2 -0
  34. package/dist/pipeline/advanced/chart/pipes/reshape/reshapeWithDualEncoding.d.ts +2 -0
  35. package/dist/pipeline/advanced/chart/pipes/reshape/reshapeWithEncoding.d.ts +2 -0
  36. package/dist/pipeline/advanced/chart/pipes/reshape/reshapeWithScatterEncoding.d.ts +2 -0
  37. package/dist/pipeline/spec/chart/pipeline/index.d.ts +0 -1
  38. package/dist/pipeline/spec/chart/pipes/color/index.d.ts +0 -1
  39. package/dist/pipeline/spec/chart/pipes/{color/linearColor.d.ts → dataset/datasetScatter.d.ts} +1 -1
  40. package/dist/pipeline/spec/chart/pipes/dataset/index.d.ts +1 -0
  41. package/dist/pipeline/spec/chart/pipes/init/index.d.ts +1 -2
  42. package/dist/pipeline/spec/chart/pipes/legend/index.d.ts +0 -1
  43. package/dist/pipeline/spec/chart/pipes/tooltip/index.d.ts +0 -1
  44. package/dist/types/advancedVSeed.d.ts +26 -311
  45. package/dist/types/chartType/area/area.d.ts +13 -1
  46. package/dist/types/chartType/area/zArea.d.ts +14 -0
  47. package/dist/types/chartType/areaPercent/areaPercent.d.ts +13 -1
  48. package/dist/types/chartType/areaPercent/zAreaPercent.d.ts +14 -0
  49. package/dist/types/chartType/bar/bar.d.ts +22 -30
  50. package/dist/types/chartType/bar/zBar.d.ts +14 -0
  51. package/dist/types/chartType/barParallel/barParallel.d.ts +21 -30
  52. package/dist/types/chartType/barParallel/zBarParallel.d.ts +14 -0
  53. package/dist/types/chartType/barPercent/barPercent.d.ts +19 -21
  54. package/dist/types/chartType/barPercent/zBarPercent.d.ts +14 -0
  55. package/dist/types/chartType/column/column.d.ts +19 -28
  56. package/dist/types/chartType/column/zColumn.d.ts +14 -0
  57. package/dist/types/chartType/columnParallel/columnParallel.d.ts +22 -27
  58. package/dist/types/chartType/columnParallel/zColumnParallel.d.ts +14 -0
  59. package/dist/types/chartType/columnPercent/columnPercent.d.ts +19 -25
  60. package/dist/types/chartType/columnPercent/zColumnPercent.d.ts +14 -0
  61. package/dist/types/chartType/donut/donut.d.ts +12 -1
  62. package/dist/types/chartType/donut/zDonut.d.ts +14 -0
  63. package/dist/types/chartType/dualAxis/dualAxis.d.ts +13 -1
  64. package/dist/types/chartType/funnel/funnel.d.ts +12 -1
  65. package/dist/types/chartType/funnel/zFunnel.d.ts +14 -0
  66. package/dist/types/chartType/heatmap/heatmap.d.ts +13 -1
  67. package/dist/types/chartType/index.d.ts +0 -1
  68. package/dist/types/chartType/line/line.d.ts +17 -10
  69. package/dist/types/chartType/line/zLine.d.ts +14 -0
  70. package/dist/types/chartType/pie/pie.d.ts +12 -1
  71. package/dist/types/chartType/pie/zPie.d.ts +14 -0
  72. package/dist/types/chartType/radar/radar.d.ts +13 -1
  73. package/dist/types/chartType/radar/zRadar.d.ts +14 -0
  74. package/dist/types/chartType/rose/rose.d.ts +13 -1
  75. package/dist/types/chartType/rose/zRose.d.ts +14 -0
  76. package/dist/types/chartType/roseParallel/roseParallel.d.ts +13 -1
  77. package/dist/types/chartType/roseParallel/zRoseParallel.d.ts +14 -0
  78. package/dist/types/chartType/scatter/scatter.d.ts +92 -5
  79. package/dist/types/chartType/scatter/zScatter.d.ts +155 -0
  80. package/dist/types/index.d.ts +2 -1
  81. package/dist/types/properties/chartType/chartType.d.ts +1 -3
  82. package/dist/types/properties/config/config.d.ts +0 -307
  83. package/dist/types/properties/datasetReshapeInfo/datasetReshapeInfo.d.ts +13 -38
  84. package/dist/types/properties/datasetReshapeInfo/index.d.ts +1 -1
  85. package/dist/types/properties/datasetReshapeInfo/zDatasetReshapeInfo.d.ts +43 -0
  86. package/dist/types/properties/encoding/encoding.d.ts +49 -16
  87. package/dist/types/properties/encoding/index.d.ts +2 -2
  88. package/dist/types/properties/encoding/zEncoding.d.ts +29 -0
  89. package/dist/types/properties/measures/index.d.ts +4 -2
  90. package/dist/types/properties/measures/scatterMeasures.d.ts +6 -0
  91. package/dist/types/properties/measures/zScatterMeasures.d.ts +283 -0
  92. package/dist/types/properties/theme/customTheme.d.ts +0 -306
  93. package/dist/types/vseed.d.ts +2 -16816
  94. package/dist/types/zVseed.d.ts +15738 -0
  95. package/dist/umd/index.js +1134 -1847
  96. package/dist/umd/index.js.map +1 -1
  97. package/package.json +13 -5
  98. package/dist/builder/register/chartType/areaRange.d.ts +0 -1
  99. package/dist/dataReshape/dataReshapeFor1D.d.ts +0 -19
  100. package/dist/dataReshape/dataReshapeFor1D1M.d.ts +0 -19
  101. package/dist/dataReshape/dataReshapeFor1D2M.d.ts +0 -19
  102. package/dist/dataReshape/dataReshapeFor2D1M.d.ts +0 -19
  103. package/dist/dataReshape/dataReshapeFor2D1M0Name.d.ts +0 -19
  104. package/dist/dataReshape/unfoldZeroDimensions.d.ts +0 -10
  105. package/dist/pipeline/advanced/chart/pipeline/areaRange.d.ts +0 -2
  106. package/dist/pipeline/advanced/chart/pipes/encoding/encodingRose.d.ts +0 -2
  107. package/dist/pipeline/advanced/chart/pipes/encoding/encodingXY.d.ts +0 -2
  108. package/dist/pipeline/advanced/chart/pipes/encoding/encodingXYY.d.ts +0 -2
  109. package/dist/pipeline/advanced/chart/pipes/encoding/encodingYX.d.ts +0 -2
  110. package/dist/pipeline/advanced/chart/pipes/encoding/encodingYY.d.ts +0 -2
  111. package/dist/pipeline/advanced/chart/pipes/init/autoMeasuresBy2M1Group.d.ts +0 -8
  112. package/dist/pipeline/advanced/chart/pipes/reshape/pivotReshapeTo1D.d.ts +0 -8
  113. package/dist/pipeline/advanced/chart/pipes/reshape/pivotReshapeTo1D1M.d.ts +0 -8
  114. package/dist/pipeline/advanced/chart/pipes/reshape/pivotReshapeTo1D2M.d.ts +0 -8
  115. package/dist/pipeline/advanced/chart/pipes/reshape/pivotReshapeTo2D1M.d.ts +0 -8
  116. package/dist/pipeline/advanced/chart/pipes/reshape/pivotReshapeTo2D1M0Name.d.ts +0 -8
  117. package/dist/pipeline/advanced/chart/pipes/reshape/pivotReshapeTo2D2M.d.ts +0 -8
  118. package/dist/pipeline/advanced/chart/pipes/reshape/reshapeTo1D.d.ts +0 -8
  119. package/dist/pipeline/advanced/chart/pipes/reshape/reshapeTo1D1M.d.ts +0 -8
  120. package/dist/pipeline/advanced/chart/pipes/reshape/reshapeTo1D2M.d.ts +0 -8
  121. package/dist/pipeline/advanced/chart/pipes/reshape/reshapeTo2D1M.d.ts +0 -8
  122. package/dist/pipeline/advanced/chart/pipes/reshape/reshapeTo2D1M0Name.d.ts +0 -8
  123. package/dist/pipeline/advanced/chart/pipes/reshape/reshapeTo2D2M.d.ts +0 -8
  124. package/dist/pipeline/spec/chart/pipeline/areaRange.d.ts +0 -1
  125. package/dist/pipeline/spec/chart/pipes/init/areaRange.d.ts +0 -4
  126. package/dist/pipeline/spec/chart/pipes/legend/colorLegend.d.ts +0 -2
  127. package/dist/pipeline/spec/chart/pipes/tooltip/tooltipAreaRange.d.ts +0 -2
  128. package/dist/types/chartType/areaRange/areaRange.d.ts +0 -151
  129. package/dist/types/chartType/areaRange/index.d.ts +0 -2
  130. package/dist/types/chartType/areaRange/zAreaRange.d.ts +0 -1427
  131. /package/dist/pipeline/spec/chart/pipes/init/{initDualAxis.d.ts → dualAxis.d.ts} +0 -0
@@ -1,5 +1,5 @@
1
1
  import type { Locale } from '../../i18n';
2
- import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XBandAxis, YLinearAxis, MeasureTree, Sort, SortLegend } from '../../properties';
2
+ import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XBandAxis, YLinearAxis, MeasureTree, Sort, SortLegend, Encoding } from '../../properties';
3
3
  /**
4
4
  * 柱状图类型定义
5
5
  * @description 柱状图,适用于纵向数据对比场景,X轴为类目轴(分类数据),Y轴为数值轴(连续数据),柱子纵向排列
@@ -20,67 +20,67 @@ import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, Annotat
20
20
  */
21
21
  export interface Column {
22
22
  /**
23
- * 柱状图
24
23
  * @description 柱状图,适用于纵向数据对比场景,X轴为类目轴(分类数据),Y轴为数值轴(连续数据),柱子纵向排列
25
24
  * @type {'column'}
26
25
  * @example 'column'
27
26
  */
28
27
  chartType: 'column';
29
28
  /**
30
- * 数据集
31
29
  * @description 符合TidyData规范的且已经聚合的数据集,用于定义图表的数据来源和结构, 用户输入的数据集并不需要进行任何处理, VSeed带有强大的数据重塑功能, 会自行进行数据重塑, 柱状图的数据最终会被转换为2个维度, 1个指标.
32
30
  * @type {Array<Record<string|number, any>>}
33
31
  * @example [{category:'A', value:100}, {category:'B', value:200}]
34
32
  */
35
33
  dataset: Dataset;
36
34
  /**
37
- * 维度
35
+ * @description 编码配置, 堆叠柱状图的视觉通道, 包括: x通道, color通道, detail通道, label通道, tooltip通道
36
+ * - x: 映射到X轴的字段, 支持放入多个维度
37
+ * - detail: 细分映射通道, 支持放入多个维度
38
+ * - tooltip: 提示映射通道, 支持放入多个维度 和 多个指标
39
+ * - color: 颜色映射通道, 支持放入多个维度 或 1个 指标
40
+ * - label: 标签映射通道, 支持放入 多个维度 或 多个指标
41
+ *
42
+ * @tip 特殊的:
43
+ * - y: measures会直接映射到Y轴通道
44
+ */
45
+ encoding?: Pick<Encoding, 'x' | 'color' | 'detail' | 'label' | 'tooltip'>;
46
+ /**
38
47
  * @description 柱状图的第一个维度被映射到X轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示
39
48
  * @type {Dimensions}
40
49
  * @example [{id: "category", alias: "类别"}]
41
50
  */
42
51
  dimensions?: Dimensions;
43
52
  /**
44
- * 指标
45
53
  * @description 柱状图的所有指标会自动合并为一个指标, 映射到Y轴, 存在多个指标时, 指标名称会与其余维度合并, 作为图例项展示.
46
54
  * @type {DimensionTree}
47
55
  * @example [{id: "value", alias: "数值"}]
48
56
  */
49
57
  measures?: MeasureTree;
50
58
  /**
51
- * 图表的背景颜色
52
- * @default transparent 默认为透明背景
53
- * @description 背景颜色可以是颜色字符串, 例如'red', 'blue', 也可以是hex, rgb或rgba'#ff0000', 'rgba(255,0,0,0.5)'
59
+ * @description 图表的背景颜色, 背景颜色可以是颜色字符串, 默认为透明背景, 例如'red', 'blue', 也可以是hex, rgb或rgba'#ff0000', 'rgba(255,0,0,0.5)'
54
60
  */
55
61
  backgroundColor?: BackgroundColor;
56
62
  /**
57
- * 颜色
58
63
  * @description 颜色配置, 用于定义图表的颜色方案, 包括颜色列表, 颜色映射, 颜色渐变等.
59
64
  */
60
65
  color?: Color;
61
66
  /**
62
- * 标签
63
67
  * @description 标签配置, 用于定义图表的数据标签, 包括数据标签的位置, 格式, 样式等.
64
68
  */
65
69
  label?: Label;
66
70
  /**
67
- * 图例
68
71
  * @description 图例配置, 用于定义图表的图例, 包括图例的位置, 格式, 样式等.
69
72
  */
70
73
  legend?: Legend;
71
74
  /**
72
- * 提示信息
73
75
  * @description 提示信息配置, 用于定义图表的提示信息, 包括提示信息的位置, 格式, 样式等.
74
76
  */
75
77
  tooltip?: Tooltip;
76
78
  /**
77
- * x
78
- * @description 类目轴, x轴配置, 用于定义图表的x轴, 包括x轴的位置, 格式, 样式等.
79
+ * @description x轴, 类目轴, x轴配置, 用于定义图表的x轴, 包括x轴的位置, 格式, 样式等.
79
80
  */
80
81
  xAxis?: XBandAxis;
81
82
  /**
82
- * y
83
- * @description 数值轴, y轴配置, 用于定义图表的y轴, 包括y轴的位置, 格式, 样式等.
83
+ * @description y轴, 数值轴, y轴配置, 用于定义图表的y轴, 包括y轴的位置, 格式, 样式等.
84
84
  */
85
85
  yAxis?: YLinearAxis;
86
86
  /**
@@ -108,28 +108,24 @@ export interface Column {
108
108
  */
109
109
  sortLegend?: SortLegend;
110
110
  /**
111
- * 图表的主题, 主题是优先级较低的功能配置, 包含所有图表类型共用的通用配置, 与单类图表类型共用的图表配置
111
+ * @description 图表的主题, 主题是优先级较低的功能配置, 包含所有图表类型共用的通用配置, 与单类图表类型共用的图表配置, 内置light与dark两种主题, 用户可以通过Builder自定义主题
112
112
  * @default light 默认为亮色主题
113
- * @description 内置light与dark两种主题, 用户可以通过Builder自定义主题
114
113
  * @example 'dark'
115
114
  * @example 'light'
116
115
  * @example 'customThemeName'
117
116
  */
118
117
  theme?: Theme;
119
118
  /**
120
- * 垂直提示框
121
119
  * @description 垂直提示框配置, 用于定义图表的垂直提示框, 包括垂直提示框的颜色、标签样式等.
122
120
  */
123
121
  crosshairRect?: CrosshairRect;
124
122
  /**
125
- * 柱状图 堆叠圆角
126
- * @description 条形图 堆叠圆角
123
+ * @description 柱状图 堆叠圆角
127
124
  * @default 8
128
125
  */
129
126
  stackCornerRadius?: StackCornerRadius;
130
127
  /**
131
- * 矩形图元样式
132
- * @description 条形图样式配置, 用于定义图表的条形图样式, 包括条形图的颜色, 边框, 圆角等.
128
+ * @description 矩形图元样式, 柱状图样式配置, 用于定义图表的柱状图样式, 包括柱状图的颜色, 边框, 圆角等.
133
129
  * 支持全局样式或条件样式配置
134
130
  * 数据筛选器
135
131
  * 若配置selector, 提供数值 selector, 局部数据 selector, 条件维度 selector, 条件指标 selector 共四类数据匹配能力
@@ -137,27 +133,22 @@ export interface Column {
137
133
  */
138
134
  barStyle?: BarStyle | BarStyle[];
139
135
  /**
140
- * 标注点
141
136
  * @description 标注点配置, 根据选择的数据, 定义图表的标注点, 包括标注点的位置, 格式, 样式等.
142
137
  */
143
138
  annotationPoint?: AnnotationPoint | AnnotationPoint[];
144
139
  /**
145
- * 标注垂直线
146
140
  * @description 标注垂直线配置, 根据选择的数据, 定义图表的标注垂直线, 包括标注垂直线的位置, 样式等.
147
141
  */
148
142
  annotationVerticalLine?: AnnotationVerticalLine | AnnotationVerticalLine[];
149
143
  /**
150
- * 标注水平线
151
144
  * @description 标注水平线配置, 根据选择的数据, 定义图表的标注水平线, 包括标注水平线的位置, 样式等.
152
145
  */
153
146
  annotationHorizontalLine?: AnnotationHorizontalLine | AnnotationHorizontalLine[];
154
147
  /**
155
- * 标注区域
156
148
  * @description 标注区域配置, 根据选择的数据, 定义图表的标注区域, 包括标注区域的位置, 样式等.
157
149
  */
158
150
  annotationArea?: AnnotationArea | AnnotationArea[];
159
151
  /**
160
- * 语言
161
152
  * @description 图表语言配置, 支持'zh-CN'与'en-US'两种语言, 另外可以调用 intl.setLocale('zh-CN') 方法设置语言
162
153
  * @default 'zh-CN'
163
154
  */
@@ -2,6 +2,20 @@ import { z } from 'zod';
2
2
  export declare const zColumn: z.ZodObject<{
3
3
  chartType: z.ZodLiteral<"column">;
4
4
  dataset: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodRecord<z.ZodUnion<[z.ZodString, z.ZodNumber]>, z.ZodAny>>>>;
5
+ encoding: z.ZodOptional<z.ZodNullable<z.ZodObject<{
6
+ x: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
7
+ y: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
8
+ angle: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
9
+ radius: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
10
+ detail: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
11
+ color: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
12
+ size: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
13
+ tooltip: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
14
+ label: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
15
+ row: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
16
+ column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
17
+ group: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
18
+ }, z.core.$strip>>>;
5
19
  dimensions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
6
20
  id: z.ZodString;
7
21
  alias: z.ZodOptional<z.ZodString>;
@@ -1,5 +1,5 @@
1
1
  import type { Locale } from '../../i18n';
2
- import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XBandAxis, YLinearAxis, MeasureTree, SortLegend, Sort } from '../../properties';
2
+ import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XBandAxis, YLinearAxis, MeasureTree, SortLegend, Sort, Encoding } from '../../properties';
3
3
  /**
4
4
  * 并列柱状图类型定义
5
5
  * @description 并列柱状图,适用于多指标并行对比场景,多个柱子并列排列展示不同指标值
@@ -20,77 +20,74 @@ import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, Annotat
20
20
  */
21
21
  export interface ColumnParallel {
22
22
  /**
23
- * 并列柱状图
24
23
  * @description 并列柱状图,适用于多指标并行对比场景
25
- * @type {'columnParallel'}
26
24
  * @example 'columnParallel'
27
25
  */
28
26
  chartType: 'columnParallel';
29
27
  /**
30
- * 数据集
31
- * @description 符合TidyData规范的且已经聚合的数据集,用于定义图表的数据来源和结构, 用户输入的数据集并不需要进行任何处理, VSeed带有强大的数据重塑功能, 会自行进行数据重塑, 并列柱状图的数据最终会被转换为2个维度, 1个指标.
32
- * @type {Array<Record<string|number, any>>}
28
+ * @description 数据集, 符合TidyData规范的且已经聚合的数据集,用于定义图表的数据来源和结构, 用户输入的数据集并不需要进行任何处理, VSeed带有强大的数据重塑功能, 会自行进行数据重塑, 并列柱状图的数据最终会被转换为2个维度, 1个指标.
33
29
  * @example [{category:'A', value1:100, value2:200}, {category:'B', value1:150, value2:250}]
34
30
  */
35
31
  dataset: Dataset;
36
32
  /**
37
- * 维度
38
- * @description 第一个维度被映射到X轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示.
33
+ * @description 编码配置, 并列柱状图的视觉通道, 包括: x通道, color通道, detail通道, label通道, tooltip通道
34
+ * - x: 映射到X轴的字段, 支持放入多个维度
35
+ * - detail: 细分映射通道, 支持放入多个维度
36
+ * - tooltip: 提示映射通道, 支持放入多个维度 和 多个指标
37
+ * - color: 颜色映射通道, 支持放入多个维度 或 1个 指标
38
+ * - label: 标签映射通道, 支持放入 多个维度 或 多个指标
39
+ *
40
+ * @tip 特殊的:
41
+ * - y: measures会直接映射到Y轴通道
42
+ */
43
+ encoding?: Pick<Encoding, 'x' | 'color' | 'detail' | 'label' | 'tooltip'>;
44
+ /**
45
+ * @description 维度, 第一个维度被映射到X轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示.
39
46
  * @type {Dimensions}
40
47
  * @example [{id: 'category', alias: '类别'}]
41
48
  */
42
49
  dimensions?: Dimensions;
43
50
  /**
44
- * 指标
45
- * @description 并列柱状图的所有指标会自动合并为一个指标, 映射到Y轴, 存在多个指标时, 指标名称会与其余维度合并, 作为图例项展示.
51
+ * @description 指标, 并列柱状图的所有指标会自动合并为一个指标, 映射到Y轴, 存在多个指标时, 指标名称会与其余维度合并, 作为图例项展示.
46
52
  * @type {DimensionTree}
47
53
  * @example [{id: 'value1', alias: '指标1'}, {id: 'value2', alias: '指标2'}]
48
54
  */
49
55
  measures?: MeasureTree;
50
56
  /**
51
- * 图表的背景颜色
57
+ * @description 图表的背景颜色, 背景颜色可以是颜色字符串, 例如'red', 'blue', 也可以是hex, rgb或rgba'#ff0000', 'rgba(255,0,0,0.5)'
52
58
  * @default transparent 默认为透明背景
53
- * @description 背景颜色可以是颜色字符串, 例如'red', 'blue', 也可以是hex, rgb或rgba'#ff0000', 'rgba(255,0,0,0.5)'
54
59
  */
55
60
  backgroundColor?: BackgroundColor;
56
61
  /**
57
- * 颜色
58
62
  * @description 颜色配置, 用于定义图表的颜色方案, 包括颜色列表, 颜色映射, 颜色渐变等.
59
63
  */
60
64
  color?: Color;
61
65
  /**
62
- * 标签
63
66
  * @description 标签配置, 用于定义图表的数据标签, 包括数据标签的位置, 格式, 样式等.
64
67
  */
65
68
  label?: Label;
66
69
  /**
67
- * 图例
68
70
  * @description 图例配置, 用于定义图表的图例, 包括图例的位置, 格式, 样式等.
69
71
  */
70
72
  legend?: Legend;
71
73
  /**
72
- * 提示信息
73
74
  * @description 提示信息配置, 用于定义图表的提示信息, 包括提示信息的位置, 格式, 样式等.
74
75
  */
75
76
  tooltip?: Tooltip;
76
77
  /**
77
- * x
78
- * @description 类目轴, x轴配置, 用于定义图表的x轴, 包括x轴的位置, 格式, 样式等.
78
+ * @description x轴, 类目轴, x轴配置, 用于定义图表的x轴, 包括x轴的位置, 格式, 样式等.
79
79
  */
80
80
  xAxis?: XBandAxis;
81
81
  /**
82
- * y
83
- * @description 数值轴, y轴配置, 用于定义图表的y轴, 包括y轴的位置, 格式, 样式等.
82
+ * @description y轴, 数值轴, y轴配置, 用于定义图表的y轴, 包括y轴的位置, 格式, 样式等.
84
83
  */
85
84
  yAxis?: YLinearAxis;
86
85
  /**
87
- * 垂直提示框
88
86
  * @description 垂直提示框配置, 用于定义图表的垂直提示框, 包括垂直提示框的颜色、标签样式等.
89
87
  */
90
88
  crosshairRect?: CrosshairRect;
91
89
  /**
92
- * 柱状图 堆叠圆角
93
- * @description 条形图 堆叠圆角
90
+ * @description 柱状图 堆叠圆角
94
91
  * @default 8
95
92
  */
96
93
  stackCornerRadius?: StackCornerRadius;
@@ -119,17 +116,15 @@ export interface ColumnParallel {
119
116
  */
120
117
  sortLegend?: SortLegend;
121
118
  /**
122
- * 图表的主题, 主题是优先级较低的功能配置, 包含所有图表类型共用的通用配置, 与单类图表类型共用的图表配置
119
+ * @description 图表的主题, 主题是优先级较低的功能配置, 包含所有图表类型共用的通用配置, 与单类图表类型共用的图表配置, 内置light与dark两种主题, 用户可以通过Builder自定义主题
123
120
  * @default light 默认为亮色主题
124
- * @description 内置light与dark两种主题, 用户可以通过Builder自定义主题
125
121
  * @example 'dark'
126
122
  * @example 'light'
127
123
  * @example 'customThemeName'
128
124
  */
129
125
  theme?: Theme;
130
126
  /**
131
- * 矩形图元样式
132
- * @description 条形图样式配置, 用于定义图表的条形图样式, 包括条形图的颜色, 边框, 圆角等.
127
+ * @description 矩形图元样式, 并列柱状图样式配置, 用于定义图表的并列柱状图样式, 包括并列柱状图的颜色, 边框, 圆角等.
133
128
  * 支持全局样式或条件样式配置
134
129
  * 数据筛选器
135
130
  * 若配置selector, 提供数值 selector, 局部数据 selector, 条件维度 selector, 条件指标 selector 共四类数据匹配能力
@@ -2,6 +2,20 @@ import { z } from 'zod';
2
2
  export declare const zColumnParallel: z.ZodObject<{
3
3
  chartType: z.ZodLiteral<"columnParallel">;
4
4
  dataset: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodRecord<z.ZodUnion<[z.ZodString, z.ZodNumber]>, z.ZodAny>>>>;
5
+ encoding: z.ZodOptional<z.ZodNullable<z.ZodObject<{
6
+ x: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
7
+ y: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
8
+ angle: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
9
+ radius: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
10
+ detail: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
11
+ color: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
12
+ size: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
13
+ tooltip: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
14
+ label: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
15
+ row: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
16
+ column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
17
+ group: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
18
+ }, z.core.$strip>>>;
5
19
  dimensions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
6
20
  id: z.ZodString;
7
21
  alias: z.ZodOptional<z.ZodString>;
@@ -1,5 +1,5 @@
1
1
  import type { Locale } from '../../i18n';
2
- import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XBandAxis, YLinearAxis, MeasureTree, Sort, SortLegend } from '../../properties';
2
+ import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XBandAxis, YLinearAxis, MeasureTree, Sort, SortLegend, Encoding } from '../../properties';
3
3
  /**
4
4
  * 百分比柱状图类型定义
5
5
  * @description 百分比柱状图,适用于展示各类别占比关系的场景,Y轴以百分比形式展示数据占比
@@ -33,6 +33,18 @@ export interface ColumnPercent {
33
33
  * @example [{category:'A', value:30}, {category:'B', value:70}]
34
34
  */
35
35
  dataset: Dataset;
36
+ /**
37
+ * @description 编码配置, 百分比柱状图的视觉通道, 包括: x通道, color通道, detail通道, label通道, tooltip通道
38
+ * - x: 映射到X轴的字段, 支持放入多个维度
39
+ * - detail: 细分映射通道, 支持放入多个维度
40
+ * - tooltip: 提示映射通道, 支持放入多个维度 和 多个指标
41
+ * - color: 颜色映射通道, 支持放入多个维度 或 1个 指标
42
+ * - label: 标签映射通道, 支持放入 多个维度 或 多个指标
43
+ *
44
+ * @tip 特殊的:
45
+ * - y: measures会直接映射到Y轴通道
46
+ */
47
+ encoding?: Pick<Encoding, 'x' | 'color' | 'detail' | 'label' | 'tooltip'>;
36
48
  /**
37
49
  * 维度
38
50
  * @description 第一个维度被映射到X轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示.
@@ -48,50 +60,39 @@ export interface ColumnPercent {
48
60
  */
49
61
  measures?: MeasureTree;
50
62
  /**
51
- * 图表的背景颜色
52
- * @default transparent 默认为透明背景
53
- * @description 背景颜色可以是颜色字符串, 例如'red', 'blue', 也可以是hex, rgb或rgba'#ff0000', 'rgba(255,0,0,0.5)'
63
+ * @description 图表的背景颜色, 默认为透明背景, 背景颜色可以是颜色字符串, 例如'red', 'blue', 也可以是hex, rgb或rgba'#ff0000', 'rgba(255,0,0,0.5)'
54
64
  */
55
65
  backgroundColor?: BackgroundColor;
56
66
  /**
57
- * 颜色
58
67
  * @description 颜色配置, 用于定义图表的颜色方案, 包括颜色列表, 颜色映射, 颜色渐变等.
59
68
  */
60
69
  color?: Color;
61
70
  /**
62
- * 标签
63
71
  * @description 标签配置, 用于定义图表的数据标签, 包括数据标签的位置, 格式, 样式等.
64
72
  */
65
73
  label?: Label;
66
74
  /**
67
- * 图例
68
75
  * @description 图例配置, 用于定义图表的图例, 包括图例的位置, 格式, 样式等.
69
76
  */
70
77
  legend?: Legend;
71
78
  /**
72
- * 提示信息
73
79
  * @description 提示信息配置, 用于定义图表的提示信息, 包括提示信息的位置, 格式, 样式等.
74
80
  */
75
81
  tooltip?: Tooltip;
76
82
  /**
77
- * x
78
- * @description 类目轴, x轴配置, 用于定义图表的x轴, 包括x轴的位置, 格式, 样式等.
83
+ * @description x轴, 类目轴, x轴配置, 用于定义图表的x轴, 包括x轴的位置, 格式, 样式等.
79
84
  */
80
85
  xAxis?: XBandAxis;
81
86
  /**
82
- * y
83
- * @description 数值轴, y轴配置, 用于定义图表的y轴, 包括y轴的位置, 格式, 样式等.
87
+ * @description y轴, 数值轴, y轴配置, 用于定义图表的y轴, 包括y轴的位置, 格式, 样式等.
84
88
  */
85
89
  yAxis?: YLinearAxis;
86
90
  /**
87
- * 垂直提示框
88
91
  * @description 垂直提示框配置, 用于定义图表的垂直提示框, 包括垂直提示框的颜色、标签样式等.
89
92
  */
90
93
  crosshairRect?: CrosshairRect;
91
94
  /**
92
- * 柱状图 堆叠圆角
93
- * @description 条形图 堆叠圆角
94
- * @default 8
95
+ * @description 并列柱状图 堆叠圆角
95
96
  */
96
97
  stackCornerRadius?: StackCornerRadius;
97
98
  /**
@@ -119,17 +120,15 @@ export interface ColumnPercent {
119
120
  */
120
121
  sortLegend?: SortLegend;
121
122
  /**
122
- * 图表的主题, 主题是优先级较低的功能配置, 包含所有图表类型共用的通用配置, 与单类图表类型共用的图表配置
123
+ * @description 图表的主题, 主题是优先级较低的功能配置, 包含所有图表类型共用的通用配置, 与单类图表类型共用的图表配置, 内置light与dark两种主题, 用户可以通过Builder自定义主题
123
124
  * @default light 默认为亮色主题
124
- * @description 内置light与dark两种主题, 用户可以通过Builder自定义主题
125
125
  * @example 'dark'
126
126
  * @example 'light'
127
127
  * @example 'customThemeName'
128
128
  */
129
129
  theme?: Theme;
130
130
  /**
131
- * 矩形图元样式
132
- * @description 条形图样式配置, 用于定义图表的条形图样式, 包括条形图的颜色, 边框, 圆角等.
131
+ * @description 矩形图元样式, 用于定义图表的矩形图元样式, 包括矩形图元的颜色, 边框, 圆角等.
133
132
  * 支持全局样式或条件样式配置
134
133
  * 数据筛选器
135
134
  * 若配置selector, 提供数值 selector, 局部数据 selector, 条件维度 selector, 条件指标 selector 共四类数据匹配能力
@@ -137,27 +136,22 @@ export interface ColumnPercent {
137
136
  */
138
137
  barStyle?: BarStyle | BarStyle[];
139
138
  /**
140
- * 标注点
141
139
  * @description 标注点配置, 根据选择的数据, 定义图表的标注点, 包括标注点的位置, 格式, 样式等.
142
140
  */
143
141
  annotationPoint?: AnnotationPoint | AnnotationPoint[];
144
142
  /**
145
- * 标注垂直线
146
143
  * @description 标注垂直线配置, 根据选择的数据, 定义图表的标注垂直线, 包括标注垂直线的位置, 样式等.
147
144
  */
148
145
  annotationVerticalLine?: AnnotationVerticalLine | AnnotationVerticalLine[];
149
146
  /**
150
- * 标注水平线
151
147
  * @description 标注水平线配置, 根据选择的数据, 定义图表的标注水平线, 包括标注水平线的位置, 样式等.
152
148
  */
153
149
  annotationHorizontalLine?: AnnotationHorizontalLine | AnnotationHorizontalLine[];
154
150
  /**
155
- * 标注区域
156
151
  * @description 标注区域配置, 根据选择的数据, 定义图表的标注区域, 包括标注区域的位置, 样式等.
157
152
  */
158
153
  annotationArea?: AnnotationArea | AnnotationArea[];
159
154
  /**
160
- * 语言
161
155
  * @description 图表语言配置, 支持'zh-CN'与'en-US'两种语言, 另外可以调用 intl.setLocale('zh-CN') 方法设置语言
162
156
  * @default 'zh-CN'
163
157
  */
@@ -2,6 +2,20 @@ import { z } from 'zod';
2
2
  export declare const zColumnPercent: z.ZodObject<{
3
3
  chartType: z.ZodLiteral<"columnPercent">;
4
4
  dataset: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodRecord<z.ZodUnion<[z.ZodString, z.ZodNumber]>, z.ZodAny>>>>;
5
+ encoding: z.ZodOptional<z.ZodNullable<z.ZodObject<{
6
+ x: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
7
+ y: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
8
+ angle: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
9
+ radius: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
10
+ detail: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
11
+ color: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
12
+ size: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
13
+ tooltip: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
14
+ label: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
15
+ row: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
16
+ column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
17
+ group: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
18
+ }, z.core.$strip>>>;
5
19
  dimensions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
6
20
  id: z.ZodString;
7
21
  alias: z.ZodOptional<z.ZodString>;
@@ -1,5 +1,5 @@
1
1
  import { type Locale } from '../../i18n';
2
- import type { BackgroundColor, Color, Dataset, Dimensions, Label, Legend, MeasureTree, Theme, Tooltip } from '../../properties';
2
+ import type { BackgroundColor, Color, Dataset, Dimensions, Encoding, Label, Legend, MeasureTree, Theme, Tooltip } from '../../properties';
3
3
  /**
4
4
  * 环形图类型定义
5
5
  * @description 环形图,适用于展示单一维度数据的占比关系,中心留有空白区域可展示汇总信息
@@ -33,6 +33,17 @@ export interface Donut {
33
33
  * @example [{category:'A', value:30}, {category:'B', value:70}]
34
34
  */
35
35
  dataset: Dataset;
36
+ /**
37
+ * @description 编码配置, 环形图的视觉通道, 包括: color通道, detail通道, label通道, tooltip通道
38
+ * - color: 颜色映射通道, 支持放入多个维度 或 1个 指标
39
+ * - detail: 细分映射通道, 支持放入多个维度
40
+ * - tooltip: 提示映射通道, 支持放入多个维度 和 多个指标
41
+ * - label: 标签映射通道, 支持放入 多个维度 或 多个指标
42
+ *
43
+ * @tip 特殊的:
44
+ * - angle: measures会直接映射到角度通道
45
+ */
46
+ encoding?: Pick<Encoding, 'color' | 'detail' | 'label' | 'tooltip'>;
36
47
  /**
37
48
  * 维度
38
49
  * @description 环形图的所有维度会与指标名称(存在多个指标时)合并成1个维度, 映射到饼图的角度, 并作为图例项展示.
@@ -2,6 +2,20 @@ import { z } from 'zod';
2
2
  export declare const zDonut: z.ZodObject<{
3
3
  chartType: z.ZodLiteral<"donut">;
4
4
  dataset: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodRecord<z.ZodUnion<[z.ZodString, z.ZodNumber]>, z.ZodAny>>>>;
5
+ encoding: z.ZodOptional<z.ZodNullable<z.ZodObject<{
6
+ x: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
7
+ y: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
8
+ angle: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
9
+ radius: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
10
+ detail: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
11
+ color: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
12
+ size: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
13
+ tooltip: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
14
+ label: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
15
+ row: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
16
+ column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
17
+ group: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
18
+ }, z.core.$strip>>>;
5
19
  dimensions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
6
20
  id: z.ZodString;
7
21
  alias: z.ZodOptional<z.ZodString>;
@@ -1,5 +1,5 @@
1
1
  import type { Locale } from '../../i18n';
2
- import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, AreaStyle, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, DualChartType, DualMeasures, Label, Legend, LineStyle, MeasureTree, PointStyle, Sort, SortLegend, Theme, Tooltip, YLinearAxis } from '../../properties';
2
+ import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, AreaStyle, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, DualChartType, DualMeasures, Encoding, Label, Legend, LineStyle, MeasureTree, PointStyle, Sort, SortLegend, Theme, Tooltip, YLinearAxis } from '../../properties';
3
3
  /**
4
4
  * 双轴图类型定义
5
5
  * @description 双轴图,适用于展示两个不同量级或不同单位指标的对比关系,包含主坐标轴和次坐标轴
@@ -31,6 +31,18 @@ export interface DualAxis {
31
31
  * @example [{month:'1月', value:100, growth:0.2}, {month:'2月', value:150, growth:0.5}]
32
32
  */
33
33
  dataset: Dataset;
34
+ /**
35
+ * @description 编码配置, 双轴图的视觉通道, 包括: x通道, color通道, detail通道, label通道, tooltip通道
36
+ * - detail: 细分映射通道, 支持放入多个维度
37
+ * - tooltip: 提示映射通道, 支持放入多个维度 和 多个指标
38
+ * - color: 颜色映射通道, 支持放入多个维度 或 1个 指标
39
+ * - label: 标签映射通道, 支持放入 多个维度 或 多个指标
40
+ *
41
+ * @tip 特殊的:
42
+ * - primaryY: measures会直接映射到主Y轴通道
43
+ * - secondaryY: measures会直接映射到次Y轴通道
44
+ */
45
+ encoding?: Pick<Encoding, 'x' | 'color' | 'detail' | 'label' | 'tooltip'>;
34
46
  /**
35
47
  * @description 维度, 第一个维度会放至X轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示.
36
48
  * @example [{id: 'month', alias: '月份'}]
@@ -1,5 +1,5 @@
1
1
  import type { Locale } from '../../i18n';
2
- import type { BackgroundColor, ColorLegend, Dataset, Dimensions, Label, LinearColor, MeasureTree, Theme, Tooltip } from '../../properties';
2
+ import type { BackgroundColor, ColorLegend, Dataset, Dimensions, Encoding, Label, LinearColor, MeasureTree, Theme, Tooltip } from '../../properties';
3
3
  /**
4
4
  * 漏斗图
5
5
  * @description 漏斗图,用于展示单一维度数据的占比关系
@@ -32,6 +32,17 @@ export interface Funnel {
32
32
  * @example [{category:'A', value:30}, {category:'B', value:70}]
33
33
  */
34
34
  dataset: Dataset;
35
+ /**
36
+ * @description 编码配置,漏斗图的视觉通道, 包括: color通道, detail通道, label通道, tooltip通道
37
+ * - detail: 细分映射通道, 支持放入多个维度
38
+ * - tooltip: 提示映射通道, 支持放入多个维度 和 多个指标
39
+ * - color: 颜色映射通道, 支持放入多个维度 或 1个 指标
40
+ * - label: 标签映射通道, 支持放入 多个维度 或 多个指标
41
+ *
42
+ * @tip 特殊的:
43
+ * - size: measures会直接映射到尺寸通道
44
+ */
45
+ encoding?: Pick<Encoding, 'color' | 'detail' | 'label' | 'tooltip'>;
35
46
  /**
36
47
  * 维度
37
48
  * @description 漏斗图的所有维度会与指标名称(存在多个指标时)合并成一个维度,并作为图例项展示
@@ -2,6 +2,20 @@ import { z } from 'zod';
2
2
  export declare const zFunnel: z.ZodObject<{
3
3
  chartType: z.ZodLiteral<"funnel">;
4
4
  dataset: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodRecord<z.ZodUnion<[z.ZodString, z.ZodNumber]>, z.ZodAny>>>>;
5
+ encoding: z.ZodOptional<z.ZodNullable<z.ZodObject<{
6
+ x: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
7
+ y: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
8
+ angle: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
9
+ radius: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
10
+ detail: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
11
+ color: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
12
+ size: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
13
+ tooltip: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
14
+ label: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
15
+ row: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
16
+ column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
17
+ group: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
18
+ }, z.core.$strip>>>;
5
19
  dimensions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
6
20
  id: z.ZodString;
7
21
  alias: z.ZodOptional<z.ZodString>;
@@ -1,5 +1,5 @@
1
1
  import { type Locale } from '../../i18n';
2
- import type { ColorLegend, LinearColor, MeasureTree } from '../../properties';
2
+ import type { ColorLegend, Encoding, LinearColor, MeasureTree } from '../../properties';
3
3
  import { type BackgroundColor, type Dataset, type Dimensions, type Label, type Theme, type Tooltip } from '../../properties';
4
4
  /**
5
5
  * 热力图类型定义
@@ -34,6 +34,18 @@ export interface Heatmap {
34
34
  * @example [{month:'1月', value:100}, {month:'2月', value:150}, {month:'3月', value:120}]
35
35
  */
36
36
  dataset: Dataset;
37
+ /**
38
+ * @description 编码配置, 热力图的视觉通道, 包括: x通道, y通道, color通道, label通道, tooltip通道
39
+ * - x: x轴映射通道, 支持放入多个维度
40
+ * - y: y轴映射通道, 支持放入多个维度
41
+ * - tooltip: 提示映射通道, 支持放入多个维度 和 多个指标
42
+ * - color: 颜色映射通道, 支持放入多个维度 或 1个 指标
43
+ * - label: 标签映射通道, 支持放入 多个维度 或 多个指标
44
+ *
45
+ * @tip 特殊的:
46
+ * - value: measures会直接映射到数值通道
47
+ */
48
+ encoding?: Pick<Encoding, 'color' | 'x' | 'y' | 'label' | 'tooltip'>;
37
49
  /**
38
50
  * 维度
39
51
  * @description 热力图的第一个维度被映射到角度轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示.
@@ -9,7 +9,6 @@ export * from './barParallel';
9
9
  export * from './barPercent';
10
10
  export * from './area';
11
11
  export * from './areaPercent';
12
- export * from './areaRange';
13
12
  export * from './scatter';
14
13
  export * from './dualAxis';
15
14
  export * from './rose';