@visactor/vseed 0.0.32 → 0.0.33

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.
@@ -278,16 +278,16 @@ export declare const zAnnotation: z.ZodObject<{
278
278
  bottom: "bottom";
279
279
  middle: "middle";
280
280
  }>>>;
281
- lineVisible: z.ZodOptional<z.ZodBoolean>;
282
- lineColor: z.ZodOptional<z.ZodString>;
283
- lineWidth: z.ZodOptional<z.ZodNumber>;
284
- lineStyle: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>;
281
+ lineVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
282
+ lineColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
283
+ lineWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
284
+ lineStyle: z.ZodOptional<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>;
285
285
  backgroundVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
286
286
  backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
287
- backgroundBorderColor: z.ZodOptional<z.ZodString>;
288
- backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
287
+ backgroundBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
289
288
  backgroundBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
290
- backgroundPadding: z.ZodOptional<z.ZodNumber>;
289
+ backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
290
+ backgroundPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
291
291
  offsetX: z.ZodDefault<z.ZodNumber>;
292
292
  offsetY: z.ZodDefault<z.ZodNumber>;
293
293
  }, z.core.$strip>, z.ZodArray<z.ZodObject<{
@@ -383,16 +383,16 @@ export declare const zAnnotation: z.ZodObject<{
383
383
  bottom: "bottom";
384
384
  middle: "middle";
385
385
  }>>>;
386
- lineVisible: z.ZodOptional<z.ZodBoolean>;
387
- lineColor: z.ZodOptional<z.ZodString>;
388
- lineWidth: z.ZodOptional<z.ZodNumber>;
389
- lineStyle: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>;
386
+ lineVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
387
+ lineColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
388
+ lineWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
389
+ lineStyle: z.ZodOptional<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>;
390
390
  backgroundVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
391
391
  backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
392
- backgroundBorderColor: z.ZodOptional<z.ZodString>;
393
- backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
392
+ backgroundBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
394
393
  backgroundBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
395
- backgroundPadding: z.ZodOptional<z.ZodNumber>;
394
+ backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
395
+ backgroundPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
396
396
  offsetX: z.ZodDefault<z.ZodNumber>;
397
397
  offsetY: z.ZodDefault<z.ZodNumber>;
398
398
  }, z.core.$strip>>]>>;
@@ -489,16 +489,16 @@ export declare const zAnnotation: z.ZodObject<{
489
489
  bottom: "bottom";
490
490
  middle: "middle";
491
491
  }>>>;
492
- lineVisible: z.ZodOptional<z.ZodBoolean>;
493
- lineColor: z.ZodOptional<z.ZodString>;
494
- lineWidth: z.ZodOptional<z.ZodNumber>;
495
- lineStyle: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>;
492
+ lineVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
493
+ lineColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
494
+ lineWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
495
+ lineStyle: z.ZodOptional<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>;
496
496
  backgroundVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
497
497
  backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
498
- backgroundBorderColor: z.ZodOptional<z.ZodString>;
499
- backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
498
+ backgroundBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
500
499
  backgroundBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
501
- backgroundPadding: z.ZodOptional<z.ZodNumber>;
500
+ backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
501
+ backgroundPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
502
502
  offsetX: z.ZodDefault<z.ZodNumber>;
503
503
  offsetY: z.ZodDefault<z.ZodNumber>;
504
504
  }, z.core.$strip>, z.ZodArray<z.ZodObject<{
@@ -594,16 +594,16 @@ export declare const zAnnotation: z.ZodObject<{
594
594
  bottom: "bottom";
595
595
  middle: "middle";
596
596
  }>>>;
597
- lineVisible: z.ZodOptional<z.ZodBoolean>;
598
- lineColor: z.ZodOptional<z.ZodString>;
599
- lineWidth: z.ZodOptional<z.ZodNumber>;
600
- lineStyle: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>;
597
+ lineVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
598
+ lineColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
599
+ lineWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
600
+ lineStyle: z.ZodOptional<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>;
601
601
  backgroundVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
602
602
  backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
603
- backgroundBorderColor: z.ZodOptional<z.ZodString>;
604
- backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
603
+ backgroundBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
605
604
  backgroundBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
606
- backgroundPadding: z.ZodOptional<z.ZodNumber>;
605
+ backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
606
+ backgroundPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
607
607
  offsetX: z.ZodDefault<z.ZodNumber>;
608
608
  offsetY: z.ZodDefault<z.ZodNumber>;
609
609
  }, z.core.$strip>>]>>;
@@ -703,18 +703,18 @@ export declare const zAnnotation: z.ZodObject<{
703
703
  }>>>;
704
704
  backgroundVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
705
705
  backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
706
- backgroundBorderColor: z.ZodOptional<z.ZodString>;
706
+ backgroundBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
707
707
  backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
708
708
  backgroundBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
709
- backgroundPadding: z.ZodOptional<z.ZodNumber>;
709
+ backgroundPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
710
710
  areaColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
711
711
  areaColorOpacity: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
712
- areaBorderColor: z.ZodOptional<z.ZodNumber>;
712
+ areaBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
713
713
  areaBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
714
714
  areaBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
715
- outerPadding: z.ZodOptional<z.ZodNumber>;
716
- offsetX: z.ZodOptional<z.ZodNumber>;
717
- offsetY: z.ZodOptional<z.ZodNumber>;
715
+ outerPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
716
+ offsetX: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
717
+ offsetY: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
718
718
  }, z.core.$strip>, z.ZodArray<z.ZodObject<{
719
719
  selector: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
720
720
  field: z.ZodString;
@@ -811,18 +811,18 @@ export declare const zAnnotation: z.ZodObject<{
811
811
  }>>>;
812
812
  backgroundVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
813
813
  backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
814
- backgroundBorderColor: z.ZodOptional<z.ZodString>;
814
+ backgroundBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
815
815
  backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
816
816
  backgroundBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
817
- backgroundPadding: z.ZodOptional<z.ZodNumber>;
817
+ backgroundPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
818
818
  areaColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
819
819
  areaColorOpacity: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
820
- areaBorderColor: z.ZodOptional<z.ZodNumber>;
820
+ areaBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
821
821
  areaBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
822
822
  areaBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
823
- outerPadding: z.ZodOptional<z.ZodNumber>;
824
- offsetX: z.ZodOptional<z.ZodNumber>;
825
- offsetY: z.ZodOptional<z.ZodNumber>;
823
+ outerPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
824
+ offsetX: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
825
+ offsetY: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
826
826
  }, z.core.$strip>>]>>;
827
827
  }, z.core.$strip>;
828
828
  export type Annotation = z.infer<typeof zAnnotation>;
@@ -2,72 +2,73 @@ import { type Selector, type Selectors } from '../../dataSelector';
2
2
  import { z } from 'zod';
3
3
  export type AnnotationArea = {
4
4
  /**
5
- * 依赖选择的数据, 进行数据标记.
5
+ * @description 依赖选择的数据, 进行数据标记.
6
6
  */
7
7
  selector: Selector | Selectors;
8
8
  /**
9
- * 标注的文本
10
9
  * @description 标注的文本
11
10
  * @default ''
12
11
  * @example '标注文本'
13
12
  */
14
13
  text?: string | string[];
15
14
  /**
16
- * 文本位置
17
15
  * @description 文本位置
18
16
  * @example 'top'
19
17
  */
20
18
  textPosition?: 'top' | 'topRight' | 'topLeft' | 'bottom' | 'bottomLeft' | 'bottomRight' | 'left' | 'right';
21
19
  /**
22
- * 文本颜色
23
20
  * @description 文本颜色
24
21
  * @example 'red'
25
22
  */
26
23
  textColor?: string;
27
24
  /**
28
- * 文本字体大小
29
25
  * @description 文本字体大小
30
26
  * @example 12
31
27
  */
32
28
  textFontSize?: number;
33
29
  /**
34
- * 文本字体重量
35
30
  * @description 文本字体重量
36
31
  * @example 400
37
32
  */
38
33
  textFontWeight?: number;
39
34
  /**
40
- * 文本对齐方式
41
- * @description 文本对齐方式
42
- * @example 'left'
35
+ * @description 文本对齐方式, 一般情况下, 设置为right, 文本显示在标注面中间, 确保显示在图表的可见区域
36
+ * 建议设置为'center', 这样可以确保文本在标注面的中间
37
+ * right: 文本在标注面的左侧, 文本的右侧边缘对齐标注面
38
+ * left: 文本在标注面的右侧, 文本的左侧边缘对齐标注面
39
+ * center: 文本在标注面的中心, 文本的中心对齐标注面
40
+ * @example 'center' 文本在标注面的中间
43
41
  */
44
42
  textAlign?: 'left' | 'right' | 'center';
45
43
  /**
46
- * 文本垂直对齐方式
47
- * @description 文本垂直对齐方式
48
- * @example 'middle'
44
+ * @description 文本垂直对齐方式, 一般情况下, 设置为top, 文本显示在标注面底部, 确保显示在图表的可见区域
45
+ * 建议设置为'top', 这样可以确保文本完整的显示在图表的可见区域
46
+ * top: 文本在标注面的底部, 文本的顶部边缘对齐标注面
47
+ * middle: 文本在标注面的中心, 文本的中心对齐标注面
48
+ * bottom: 文本在标注面的顶部, 文本的底部边缘对齐标注面
49
+ * @example 'top' 文本在标注面的底部
49
50
  */
50
51
  textBaseline?: 'top' | 'middle' | 'bottom';
51
52
  /**
52
- * Y方向的, 偏移量
53
- * @description 文本Y方向的, 偏移量, 支持正负
54
- * @example offsetY: 10
53
+ * @description 标注面整体在Y方向的偏移像素距离, 当标注面在图表上方(数值较大时)时, 建议设置为正值, 标注面在图表下方(数值较小时)时, 建议设置为负值.
54
+ * 负值则整体向上偏移, 例如设置为-10, 则整个标注面组件包括文本、面图元, 一起向上偏移10像素
55
+ * 正值则整体向下偏移, 例如设置为10, 则整个标注面组件包括文本、面图元, 一起向下偏移10像素
56
+ * @example offsetY: 5, 标注面整体向下偏移5像素
55
57
  */
56
58
  offsetY?: number;
57
59
  /**
58
- * X方向的, 偏移量
59
- * @description 文本X方向的, 偏移量, 支持正负
60
- * @example offsetX: -10
60
+ * @description 标注面整体在X方向的偏移像素距离, 当标注面在图表左侧(类目轴起点)时, 建议设置为正值, 标注面在图表右侧(类目轴终点)时, 建议设置为负值.
61
+ * 负值则整体向左偏移, 例如设置为-10, 则整个标注面组件包括文本、面图元, 一起向左偏移10像素
62
+ * 正值则整体向右偏移, 例如设置为10, 则整个标注面组件包括文本、面图元, 一起向右偏移10像素
63
+ * @example offsetX: 5, 标注面整体向右偏移5像素
61
64
  */
62
65
  offsetX?: number;
63
66
  /**
64
- * 背景可见
65
67
  * @description 背景可见
66
68
  * @example true
67
69
  */
68
70
  backgroundVisible?: boolean;
69
71
  /**
70
- * 背景颜色
71
72
  * @description 背景颜色
72
73
  * @example 'red'
73
74
  */
@@ -79,7 +80,6 @@ export type AnnotationArea = {
79
80
  */
80
81
  backgroundBorderColor?: string;
81
82
  /**
82
- * 背景边框宽度
83
83
  * @description 背景边框宽度
84
84
  * @example 2
85
85
  */
@@ -91,44 +91,37 @@ export type AnnotationArea = {
91
91
  */
92
92
  backgroundBorderRadius?: number;
93
93
  /**
94
- * 背景内边距
95
94
  * @description 背景内边距
96
95
  * @example 4
97
96
  */
98
97
  backgroundPadding?: number;
99
98
  /**
100
- * 面积区域颜色
101
99
  * @description 面积区域颜色
102
100
  * @example 'red'
103
101
  */
104
102
  areaColor?: string;
105
103
  /**
106
- * 面积区域颜色透明度
107
104
  * @description 面积区域颜色透明度
108
105
  * @example 0.5
109
106
  */
110
107
  areaColorOpacity?: number;
111
108
  /**
112
- * 面积区域边框颜色
113
109
  * @description 面积区域边框颜色
114
110
  * @default 'red'
115
111
  * @example 'red'
116
112
  */
117
113
  areaBorderColor?: number;
118
114
  /**
119
- * 面积区域边框宽度
120
115
  * @description 面积区域边框宽度
121
116
  * @example 2
122
117
  */
123
118
  areaBorderWidth?: number;
124
119
  /**
125
- * 面积区域边框圆角
126
120
  * @description 面积区域边框圆角
127
121
  * @example 4
128
122
  */
129
123
  areaBorderRadius?: number;
130
124
  /**
131
- * 面积区域的边距
132
125
  * @description 面积区域的边距
133
126
  * @example 0
134
127
  */
@@ -230,16 +223,16 @@ export declare const zAnnotationArea: z.ZodObject<{
230
223
  }>>>;
231
224
  backgroundVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
232
225
  backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
233
- backgroundBorderColor: z.ZodOptional<z.ZodString>;
226
+ backgroundBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
234
227
  backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
235
228
  backgroundBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
236
- backgroundPadding: z.ZodOptional<z.ZodNumber>;
229
+ backgroundPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
237
230
  areaColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
238
231
  areaColorOpacity: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
239
- areaBorderColor: z.ZodOptional<z.ZodNumber>;
232
+ areaBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
240
233
  areaBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
241
234
  areaBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
242
- outerPadding: z.ZodOptional<z.ZodNumber>;
243
- offsetX: z.ZodOptional<z.ZodNumber>;
244
- offsetY: z.ZodOptional<z.ZodNumber>;
235
+ outerPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
236
+ offsetX: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
237
+ offsetY: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
245
238
  }, z.core.$strip>;
@@ -217,16 +217,16 @@ export declare const zAnnotationHorizontalLine: z.ZodObject<{
217
217
  bottom: "bottom";
218
218
  middle: "middle";
219
219
  }>>>;
220
- lineVisible: z.ZodOptional<z.ZodBoolean>;
221
- lineColor: z.ZodOptional<z.ZodString>;
222
- lineWidth: z.ZodOptional<z.ZodNumber>;
223
- lineStyle: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>;
220
+ lineVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
221
+ lineColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
222
+ lineWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
223
+ lineStyle: z.ZodOptional<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>;
224
224
  backgroundVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
225
225
  backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
226
- backgroundBorderColor: z.ZodOptional<z.ZodString>;
227
- backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
226
+ backgroundBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
228
227
  backgroundBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
229
- backgroundPadding: z.ZodOptional<z.ZodNumber>;
228
+ backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
229
+ backgroundPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
230
230
  offsetX: z.ZodDefault<z.ZodNumber>;
231
231
  offsetY: z.ZodDefault<z.ZodNumber>;
232
232
  }, z.core.$strip>;
@@ -1,90 +1,92 @@
1
1
  import { type Selector, type Selectors } from '../../dataSelector';
2
2
  import { z } from 'zod';
3
+ /**
4
+ * @description 标注点, 根据用户设置的selector, 在数据点的左下方, 显示一个带有背景的标签.
5
+ */
3
6
  export type AnnotationPoint = {
4
7
  /**
5
- * 依赖选择的数据, 进行数据标记.
8
+ * @description 标注点的选择器, 用于选择数据点.
6
9
  */
7
10
  selector: Selector | Selectors;
8
11
  /**
9
- * 标注的文本
10
12
  * @description 标注的文本
11
13
  * @default ''
12
14
  * @example '标注文本'
13
15
  */
14
16
  text?: string | string[];
15
17
  /**
16
- * 文本颜色
17
18
  * @description 文本颜色
18
19
  * @example 'red'
19
20
  */
20
21
  textColor?: string;
21
22
  /**
22
- * 文本字体大小
23
23
  * @description 文本字体大小
24
24
  * @example 12
25
25
  */
26
26
  textFontSize?: number;
27
27
  /**
28
- * 文本字体重量
29
28
  * @description 文本字体重量
30
29
  * @example 400
31
30
  */
32
31
  textFontWeight?: number;
33
32
  /**
34
- * 文本对齐方式
35
- * @description 文本对齐方式
36
- * @example 'left'
33
+ * @description 文本对齐方式, 一般情况下, 设置为right, 文本显示在标注点左侧, 确保显示在图表的可见区域
34
+ * 建议设置为'right', 这样可以确保文本在标注点的左侧
35
+ * right: 文本在标注点的左侧, 文本的右侧边缘对齐标注点
36
+ * left: 文本在标注点的右侧, 文本的左侧边缘对齐标注点
37
+ * center: 文本在标注点的中心, 文本的中心对齐标注点
38
+ * @example 'right' 文本在标注点的左侧
37
39
  */
38
40
  textAlign?: 'left' | 'right' | 'center';
39
41
  /**
40
- * 文本垂直对齐方式
41
- * @description 文本垂直对齐方式
42
- * @example 'middle'
42
+ * @description 文本垂直对齐方式, 一般情况下, 设置为top, 文本显示在标注点底部, 确保显示在图表的可见区域
43
+ * 建议设置为'top', 这样可以确保文本完整的显示在图表的可见区域
44
+ * top: 文本在标注点的底部, 文本的顶部边缘对齐标注点
45
+ * middle: 文本在标注点的中心, 文本的中心对齐标注点
46
+ * bottom: 文本在标注点的顶部, 文本的底部边缘对齐标注点
47
+ * @example 'top' 文本在标注点的底部
43
48
  */
44
49
  textBaseline?: 'top' | 'middle' | 'bottom';
45
50
  /**
46
- * 文本Y方向的, 偏移量
47
- * @example offsetY: 10
51
+ * @description 标注点整体在Y方向的偏移像素距离, 当标注点在图表上方(数值较大时)时, 建议设置为正值, 标注点在图表下方(数值较小时)时, 建议设置为负值.
52
+ * 负值则整体向上偏移, 例如设置为-10, 则整个标注点组件包括文本、文本背景, 一起向上偏移10像素
53
+ * 正值则整体向下偏移, 例如设置为10, 则整个标注点组件包括文本、文本背景, 一起向下偏移10像素
54
+ * @example offsetY: 5, 标注点整体向下偏移5像素
48
55
  */
49
56
  offsetY?: number;
50
57
  /**
51
- * 文本X方向的, 偏移量
52
- * @description 文本X方向的, 偏移量, 支持正负
53
- * @example offsetX: -10
58
+ * @description 标注点整体在X方向的偏移像素距离, 当标注点在图表左侧(类目轴起点)时, 建议设置为正值, 标注点在图表右侧(类目轴终点)时, 建议设置为负值.
59
+ * 负值则整体向左偏移, 例如设置为-10, 则整个标注点组件包括文本、文本背景, 一起向左偏移10像素
60
+ * 正值则整体向右偏移, 例如设置为10, 则整个标注点组件包括文本、文本背景, 一起向右偏移10像素
61
+ * @example offsetX: 5, 标注点整体向右偏移5像素
54
62
  */
55
63
  offsetX?: number;
56
64
  /**
57
- * 背景可见
58
65
  * @description 背景可见
59
66
  * @example true
60
67
  */
61
68
  backgroundVisible?: boolean;
62
69
  /**
63
- * 背景颜色
64
70
  * @description 背景颜色
65
71
  * @example 'red'
66
72
  */
67
73
  backgroundColor?: string;
68
74
  /**
69
- * 背景边框颜色
70
75
  * @description 背景边框颜色
71
76
  * @example 'red'
72
77
  */
73
78
  backgroundBorderColor?: string;
74
79
  /**
75
- * 背景边框宽度
76
80
  * @description 背景边框宽度
77
81
  * @example 2
78
82
  */
79
83
  backgroundBorderWidth?: number;
80
84
  /**
81
- * 背景边框圆角
82
85
  * @description 背景边框圆角
83
86
  * @example 4
84
87
  */
85
88
  backgroundBorderRadius?: number;
86
89
  /**
87
- * 背景内边距
88
90
  * @description 背景内边距
89
91
  * @example 4
90
92
  */
@@ -214,16 +214,16 @@ export declare const zAnnotationVerticalLine: z.ZodObject<{
214
214
  bottom: "bottom";
215
215
  middle: "middle";
216
216
  }>>>;
217
- lineVisible: z.ZodOptional<z.ZodBoolean>;
218
- lineColor: z.ZodOptional<z.ZodString>;
219
- lineWidth: z.ZodOptional<z.ZodNumber>;
220
- lineStyle: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>;
217
+ lineVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
218
+ lineColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
219
+ lineWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
220
+ lineStyle: z.ZodOptional<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>;
221
221
  backgroundVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
222
222
  backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
223
- backgroundBorderColor: z.ZodOptional<z.ZodString>;
224
- backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
223
+ backgroundBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
225
224
  backgroundBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
226
- backgroundPadding: z.ZodOptional<z.ZodNumber>;
225
+ backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
226
+ backgroundPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
227
227
  offsetX: z.ZodDefault<z.ZodNumber>;
228
228
  offsetY: z.ZodDefault<z.ZodNumber>;
229
229
  }, z.core.$strip>;