@visactor/vseed 0.0.31 → 0.0.33

package/dist/types/properties/annotation/annotation.d.ts

@@ -278,16 +278,16 @@ export declare const zAnnotation: z.ZodObject<{
             bottom: "bottom";
             middle: "middle";
         }>>>;
-        lineVisible: z.ZodOptional<z.ZodBoolean>;
-        lineColor: z.ZodOptional<z.ZodString>;
-        lineWidth: z.ZodOptional<z.ZodNumber>;
-        lineStyle: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>;
+        lineVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        lineColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+        lineWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        lineStyle: z.ZodOptional<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>;
         backgroundVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
         backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-        backgroundBorderColor: z.ZodOptional<z.ZodString>;
-        backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        backgroundBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
         backgroundBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-        backgroundPadding: z.ZodOptional<z.ZodNumber>;
+        backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        backgroundPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
         offsetX: z.ZodDefault<z.ZodNumber>;
         offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>, z.ZodArray<z.ZodObject<{
@@ -383,16 +383,16 @@ export declare const zAnnotation: z.ZodObject<{
             bottom: "bottom";
             middle: "middle";
         }>>>;
-        lineVisible: z.ZodOptional<z.ZodBoolean>;
-        lineColor: z.ZodOptional<z.ZodString>;
-        lineWidth: z.ZodOptional<z.ZodNumber>;
-        lineStyle: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>;
+        lineVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        lineColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+        lineWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        lineStyle: z.ZodOptional<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>;
         backgroundVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
         backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-        backgroundBorderColor: z.ZodOptional<z.ZodString>;
-        backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        backgroundBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
         backgroundBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-        backgroundPadding: z.ZodOptional<z.ZodNumber>;
+        backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        backgroundPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
         offsetX: z.ZodDefault<z.ZodNumber>;
         offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>>]>>;
@@ -489,16 +489,16 @@ export declare const zAnnotation: z.ZodObject<{
             bottom: "bottom";
             middle: "middle";
         }>>>;
-        lineVisible: z.ZodOptional<z.ZodBoolean>;
-        lineColor: z.ZodOptional<z.ZodString>;
-        lineWidth: z.ZodOptional<z.ZodNumber>;
-        lineStyle: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>;
+        lineVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        lineColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+        lineWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        lineStyle: z.ZodOptional<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>;
         backgroundVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
         backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-        backgroundBorderColor: z.ZodOptional<z.ZodString>;
-        backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        backgroundBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
         backgroundBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-        backgroundPadding: z.ZodOptional<z.ZodNumber>;
+        backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        backgroundPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
         offsetX: z.ZodDefault<z.ZodNumber>;
         offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>, z.ZodArray<z.ZodObject<{
@@ -594,16 +594,16 @@ export declare const zAnnotation: z.ZodObject<{
             bottom: "bottom";
             middle: "middle";
         }>>>;
-        lineVisible: z.ZodOptional<z.ZodBoolean>;
-        lineColor: z.ZodOptional<z.ZodString>;
-        lineWidth: z.ZodOptional<z.ZodNumber>;
-        lineStyle: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>;
+        lineVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        lineColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+        lineWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        lineStyle: z.ZodOptional<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>;
         backgroundVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
         backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-        backgroundBorderColor: z.ZodOptional<z.ZodString>;
-        backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        backgroundBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
         backgroundBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-        backgroundPadding: z.ZodOptional<z.ZodNumber>;
+        backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        backgroundPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
         offsetX: z.ZodDefault<z.ZodNumber>;
         offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>>]>>;
@@ -703,18 +703,18 @@ export declare const zAnnotation: z.ZodObject<{
         }>>>;
         backgroundVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
         backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-        backgroundBorderColor: z.ZodOptional<z.ZodString>;
+        backgroundBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
         backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
         backgroundBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-        backgroundPadding: z.ZodOptional<z.ZodNumber>;
+        backgroundPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
         areaColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
         areaColorOpacity: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-        areaBorderColor: z.ZodOptional<z.ZodNumber>;
+        areaBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
         areaBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
         areaBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-        outerPadding: z.ZodOptional<z.ZodNumber>;
-        offsetX: z.ZodOptional<z.ZodNumber>;
-        offsetY: z.ZodOptional<z.ZodNumber>;
+        outerPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        offsetX: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        offsetY: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
     }, z.core.$strip>, z.ZodArray<z.ZodObject<{
         selector: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
             field: z.ZodString;
@@ -811,18 +811,18 @@ export declare const zAnnotation: z.ZodObject<{
         }>>>;
         backgroundVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
         backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-        backgroundBorderColor: z.ZodOptional<z.ZodString>;
+        backgroundBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
         backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
         backgroundBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-        backgroundPadding: z.ZodOptional<z.ZodNumber>;
+        backgroundPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
         areaColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
         areaColorOpacity: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-        areaBorderColor: z.ZodOptional<z.ZodNumber>;
+        areaBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
         areaBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
         areaBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-        outerPadding: z.ZodOptional<z.ZodNumber>;
-        offsetX: z.ZodOptional<z.ZodNumber>;
-        offsetY: z.ZodOptional<z.ZodNumber>;
+        outerPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        offsetX: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        offsetY: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
     }, z.core.$strip>>]>>;
 }, z.core.$strip>;
 export type Annotation = z.infer<typeof zAnnotation>;

package/dist/types/properties/annotation/annotationArea.d.ts

@@ -2,72 +2,73 @@ import { type Selector, type Selectors } from '../../dataSelector';
 import { z } from 'zod';
 export type AnnotationArea = {
     /**
-     * 依赖选择的数据, 进行数据标记.
+     * @description 依赖选择的数据, 进行数据标记.
      */
     selector: Selector | Selectors;
     /**
-     * 标注的文本
      * @description 标注的文本
      * @default ''
      * @example '标注文本'
      */
     text?: string | string[];
     /**
-     * 文本位置
      * @description 文本位置
      * @example 'top'
      */
     textPosition?: 'top' | 'topRight' | 'topLeft' | 'bottom' | 'bottomLeft' | 'bottomRight' | 'left' | 'right';
     /**
-     * 文本颜色
      * @description 文本颜色
      * @example 'red'
      */
     textColor?: string;
     /**
-     * 文本字体大小
      * @description 文本字体大小
      * @example 12
      */
     textFontSize?: number;
     /**
-     * 文本字体重量
      * @description 文本字体重量
      * @example 400
      */
     textFontWeight?: number;
     /**
-     * 文本对齐方式
-     * @description 文本对齐方式
-     * @example 'left'
+     * @description 文本对齐方式, 一般情况下, 设置为right, 文本显示在标注面中间, 确保显示在图表的可见区域
+     * 建议设置为'center', 这样可以确保文本在标注面的中间
+     * right: 文本在标注面的左侧, 文本的右侧边缘对齐标注面
+     * left: 文本在标注面的右侧, 文本的左侧边缘对齐标注面
+     * center: 文本在标注面的中心, 文本的中心对齐标注面
+     * @example 'center' 文本在标注面的中间
      */
     textAlign?: 'left' | 'right' | 'center';
     /**
-     * 文本垂直对齐方式
-     * @description 文本垂直对齐方式
-     * @example 'middle'
+     * @description 文本垂直对齐方式, 一般情况下, 设置为top, 文本显示在标注面底部, 确保显示在图表的可见区域
+     * 建议设置为'top', 这样可以确保文本完整的显示在图表的可见区域
+     * top: 文本在标注面的底部, 文本的顶部边缘对齐标注面
+     * middle: 文本在标注面的中心, 文本的中心对齐标注面
+     * bottom: 文本在标注面的顶部, 文本的底部边缘对齐标注面
+     * @example 'top' 文本在标注面的底部
      */
     textBaseline?: 'top' | 'middle' | 'bottom';
     /**
-     * Y方向的, 偏移量
-     * @description 文本Y方向的, 偏移量, 支持正负
-     * @example offsetY: 10
+     * @description 标注面整体在Y方向的偏移像素距离, 当标注面在图表上方(数值较大时)时, 建议设置为正值, 标注面在图表下方(数值较小时)时, 建议设置为负值.
+     * 负值则整体向上偏移, 例如设置为-10, 则整个标注面组件包括文本、面图元, 一起向上偏移10像素
+     * 正值则整体向下偏移, 例如设置为10, 则整个标注面组件包括文本、面图元, 一起向下偏移10像素
+     * @example offsetY: 5, 标注面整体向下偏移5像素
      */
     offsetY?: number;
     /**
-     * X方向的, 偏移量
-     * @description 文本X方向的, 偏移量, 支持正负
-     * @example offsetX: -10
+     * @description 标注面整体在X方向的偏移像素距离, 当标注面在图表左侧(类目轴起点)时, 建议设置为正值, 标注面在图表右侧(类目轴终点)时, 建议设置为负值.
+     * 负值则整体向左偏移, 例如设置为-10, 则整个标注面组件包括文本、面图元, 一起向左偏移10像素
+     * 正值则整体向右偏移, 例如设置为10, 则整个标注面组件包括文本、面图元, 一起向右偏移10像素
+     * @example offsetX: 5, 标注面整体向右偏移5像素
      */
     offsetX?: number;
     /**
-     * 背景可见
      * @description 背景可见
      * @example true
      */
     backgroundVisible?: boolean;
     /**
-     * 背景颜色
      * @description 背景颜色
      * @example 'red'
      */
@@ -79,7 +80,6 @@ export type AnnotationArea = {
      */
     backgroundBorderColor?: string;
     /**
-     * 背景边框宽度
      * @description 背景边框宽度
      * @example 2
      */
@@ -91,44 +91,37 @@ export type AnnotationArea = {
      */
     backgroundBorderRadius?: number;
     /**
-     * 背景内边距
      * @description 背景内边距
      * @example 4
      */
     backgroundPadding?: number;
     /**
-     * 面积区域颜色
      * @description 面积区域颜色
      * @example 'red'
      */
     areaColor?: string;
     /**
-     * 面积区域颜色透明度
      * @description 面积区域颜色透明度
      * @example 0.5
      */
     areaColorOpacity?: number;
     /**
-     * 面积区域边框颜色
      * @description 面积区域边框颜色
      * @default 'red'
      * @example 'red'
      */
     areaBorderColor?: number;
     /**
-     * 面积区域边框宽度
      * @description 面积区域边框宽度
      * @example 2
      */
     areaBorderWidth?: number;
     /**
-     * 面积区域边框圆角
      * @description 面积区域边框圆角
      * @example 4
      */
     areaBorderRadius?: number;
     /**
-     * 面积区域的边距
      * @description 面积区域的边距
      * @example 0
      */
@@ -230,16 +223,16 @@ export declare const zAnnotationArea: z.ZodObject<{
     }>>>;
     backgroundVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
     backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-    backgroundBorderColor: z.ZodOptional<z.ZodString>;
+    backgroundBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
     backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
     backgroundBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-    backgroundPadding: z.ZodOptional<z.ZodNumber>;
+    backgroundPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
     areaColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
     areaColorOpacity: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-    areaBorderColor: z.ZodOptional<z.ZodNumber>;
+    areaBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
     areaBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
     areaBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-    outerPadding: z.ZodOptional<z.ZodNumber>;
-    offsetX: z.ZodOptional<z.ZodNumber>;
-    offsetY: z.ZodOptional<z.ZodNumber>;
+    outerPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+    offsetX: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+    offsetY: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
 }, z.core.$strip>;

package/dist/types/properties/annotation/annotationHorizontalLine.d.ts

@@ -1,17 +1,18 @@
 import { type Selector, type Selectors } from '../../dataSelector';
 import { z } from 'zod';
+/**
+ * @description 水平标注线, 根据用户设置的selector 或 yValue, 从左向右绘制一条末尾有箭头的线, 标签默认在标注线的终点正下方
+ */
 export type AnnotationHorizontalLine = {
     /**
-     * 依赖选择的数据, 进行数据标记.
+     * @description 依赖选择的数据, 进行数据标记.
      */
     selector?: Selector | Selectors;
     /**
-     * 固定的y值, 用于标注水平线
-     * @description 类目轴在y方向, 则可输入维值, 数值轴在y方向, 则可输入具体的数值
+     * @description  固定的y值, 用于标注水平线, 类目轴在y方向, 则可输入维值, 数值轴在y方向, 则可输入具体的数值
      */
     yValue?: (number | string) | (number | string)[];
     /**
-     * 标注的文本
      * @description 标注的文本
      * @default ''
      * @example '标注文本'
@@ -24,45 +25,50 @@ export type AnnotationHorizontalLine = {
      */
     textPosition?: 'outsideStart' | 'outsideEnd' | 'outsideMiddle' | 'insideStart' | 'insideMiddle' | 'insideEnd';
     /**
-     * 文本颜色
      * @description 文本颜色
      * @example 'red'
      */
     textColor?: string;
     /**
-     * 文本字体大小
      * @description 文本字体大小
      * @example 12
      */
     textFontSize?: number;
     /**
-     * 文本字体重量
      * @description 文本字体重量
      * @example 400
      */
     textFontWeight?: number;
     /**
-     * 文本对齐方式
-     * @description 文本对齐方式
-     * @example 'center'
+     * @description 文本对齐方式, 一般情况下, 无需设置
+     * 建议设置为'right', 这样可以确保文本在标注线的左侧
+     * right: 文本在参考线的左侧, 文本的右侧边缘对齐(水平)标注线的终点
+     * left: 文本在参考线的右侧, 文本的左侧边缘对齐(水平)标注线的终点
+     * center: 文本在参考线的中心, 文本的中心对齐(水平)标注线的终点
+     * @example 'right'
      */
     textAlign?: 'left' | 'right' | 'center';
     /**
-     * 文本垂直对齐方式
-     * @description 文本垂直对齐方式
-     * @example 'middle'
+     * @description 文本垂直对齐方式, 一般情况下, 无需设置
+     * 建议设置为'top', 这样可以确保文本完整的显示在图表的可见区域
+     * top: 文本在参考线的底部, 文本的顶部边缘对齐(水平)标注线
+     * middle: 文本在参考线的中心, 文本的中心对齐(水平)标注线
+     * bottom: 文本在参考线的顶部, 文本的底部边缘对齐(水平)标注线
+     * @example 'top'
      */
     textBaseline?: 'top' | 'middle' | 'bottom';
     /**
-     * 文本Y方向的, 偏移量
-     * @description 文本Y方向的, 偏移量, 支持正负
-     * @example offsetY: 10
+     * @description (水平)标注线整体在Y方向的偏移像素距离, 一般情况下, 无需设置
+     * 负值则整体向上偏移, 例如设置为-10, 则整个(水平)标注线组件包括文本、箭头、线段, 一起向上偏移10像素
+     * 正值则整体向下偏移, 例如设置为10, 则整个(水平)标注线组件包括文本、箭头、线段, 一起向下偏移10像素
+     * @example offsetY: 0
      */
     offsetY?: number;
     /**
-     * 文本X方向的, 偏移量
-     * @description 文本X方向的, 偏移量, 支持正负
-     * @example offsetX: -10
+     * @description (水平)标注线整体在X方向的偏移像素距离, 一般情况下, 无需设置
+     * 负值则整体向左偏移, 例如设置为-10, 则整个(水平)标注线组件包括文本、箭头、线段, 一起向左偏移10像素
+     * 正值则整体向右偏移, 例如设置为10, 则整个(水平)标注线组件包括文本、箭头、线段, 一起向右偏移10像素
+     * @example offsetX: 0
      */
     offsetX?: number;
     /**
@@ -72,37 +78,31 @@ export type AnnotationHorizontalLine = {
      */
     lineVisible?: boolean;
     /**
-     * 线颜色
      * @description 线颜色
      * @example 'red'
      */
     lineColor?: string;
     /**
-     * 线宽度
      * @description 线宽度
      * @example 2
      */
     lineWidth?: number;
     /**
-     * 线样式
      * @description 线样式
      * @example 'solid'
      */
     lineStyle?: 'solid' | 'dashed' | 'dotted';
     /**
-     * 背景可见
      * @description 背景可见
      * @example true
      */
     backgroundVisible?: boolean;
     /**
-     * 背景颜色
      * @description 背景颜色
      * @example 'red'
      */
     backgroundColor?: string;
     /**
-     * 背景边框颜色
      * @description 背景边框颜色
      * @example 'red'
      */
@@ -114,13 +114,11 @@ export type AnnotationHorizontalLine = {
      */
     backgroundBorderWidth?: number;
     /**
-     * 背景边框圆角
      * @description 背景边框圆角
      * @example 4
      */
     backgroundBorderRadius?: number;
     /**
-     * 背景内边距
      * @description 背景内边距
      * @example 4
      */
@@ -219,16 +217,16 @@ export declare const zAnnotationHorizontalLine: z.ZodObject<{
         bottom: "bottom";
         middle: "middle";
     }>>>;
-    lineVisible: z.ZodOptional<z.ZodBoolean>;
-    lineColor: z.ZodOptional<z.ZodString>;
-    lineWidth: z.ZodOptional<z.ZodNumber>;
-    lineStyle: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>;
+    lineVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    lineColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+    lineWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+    lineStyle: z.ZodOptional<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>;
     backgroundVisible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
     backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-    backgroundBorderColor: z.ZodOptional<z.ZodString>;
-    backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+    backgroundBorderColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
     backgroundBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-    backgroundPadding: z.ZodOptional<z.ZodNumber>;
+    backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+    backgroundPadding: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
     offsetX: z.ZodDefault<z.ZodNumber>;
     offsetY: z.ZodDefault<z.ZodNumber>;
 }, z.core.$strip>;

package/dist/types/properties/annotation/annotationPoint.d.ts

@@ -1,90 +1,92 @@
 import { type Selector, type Selectors } from '../../dataSelector';
 import { z } from 'zod';
+/**
+ * @description 标注点, 根据用户设置的selector, 在数据点的左下方, 显示一个带有背景的标签.
+ */
 export type AnnotationPoint = {
     /**
-     * 依赖选择的数据, 进行数据标记.
+     * @description 标注点的选择器, 用于选择数据点.
      */
     selector: Selector | Selectors;
     /**
-     * 标注的文本
      * @description 标注的文本
      * @default ''
      * @example '标注文本'
      */
     text?: string | string[];
     /**
-     * 文本颜色
      * @description 文本颜色
      * @example 'red'
      */
     textColor?: string;
     /**
-     * 文本字体大小
      * @description 文本字体大小
      * @example 12
      */
     textFontSize?: number;
     /**
-     * 文本字体重量
      * @description 文本字体重量
      * @example 400
      */
     textFontWeight?: number;
     /**
-     * 文本对齐方式
-     * @description 文本对齐方式
-     * @example 'left'
+     * @description 文本对齐方式, 一般情况下, 设置为right, 文本显示在标注点左侧, 确保显示在图表的可见区域
+     * 建议设置为'right', 这样可以确保文本在标注点的左侧
+     * right: 文本在标注点的左侧, 文本的右侧边缘对齐标注点
+     * left: 文本在标注点的右侧, 文本的左侧边缘对齐标注点
+     * center: 文本在标注点的中心, 文本的中心对齐标注点
+     * @example 'right' 文本在标注点的左侧
      */
     textAlign?: 'left' | 'right' | 'center';
     /**
-     * 文本垂直对齐方式
-     * @description 文本垂直对齐方式
-     * @example 'middle'
+     * @description 文本垂直对齐方式, 一般情况下, 设置为top, 文本显示在标注点底部, 确保显示在图表的可见区域
+     * 建议设置为'top', 这样可以确保文本完整的显示在图表的可见区域
+     * top: 文本在标注点的底部, 文本的顶部边缘对齐标注点
+     * middle: 文本在标注点的中心, 文本的中心对齐标注点
+     * bottom: 文本在标注点的顶部, 文本的底部边缘对齐标注点
+     * @example 'top' 文本在标注点的底部
      */
     textBaseline?: 'top' | 'middle' | 'bottom';
     /**
-     * 文本Y方向的, 偏移量
-     * @example offsetY: 10
+     * @description 标注点整体在Y方向的偏移像素距离, 当标注点在图表上方(数值较大时)时, 建议设置为正值, 标注点在图表下方(数值较小时)时, 建议设置为负值.
+     * 负值则整体向上偏移, 例如设置为-10, 则整个标注点组件包括文本、文本背景, 一起向上偏移10像素
+     * 正值则整体向下偏移, 例如设置为10, 则整个标注点组件包括文本、文本背景, 一起向下偏移10像素
+     * @example offsetY: 5, 标注点整体向下偏移5像素
      */
     offsetY?: number;
     /**
-     * 文本X方向的, 偏移量
-     * @description 文本X方向的, 偏移量, 支持正负
-     * @example offsetX: -10
+     * @description 标注点整体在X方向的偏移像素距离, 当标注点在图表左侧(类目轴起点)时, 建议设置为正值, 标注点在图表右侧(类目轴终点)时, 建议设置为负值.
+     * 负值则整体向左偏移, 例如设置为-10, 则整个标注点组件包括文本、文本背景, 一起向左偏移10像素
+     * 正值则整体向右偏移, 例如设置为10, 则整个标注点组件包括文本、文本背景, 一起向右偏移10像素
+     * @example offsetX: 5, 标注点整体向右偏移5像素
      */
     offsetX?: number;
     /**
-     * 背景可见
      * @description 背景可见
      * @example true
      */
     backgroundVisible?: boolean;
     /**
-     * 背景颜色
      * @description 背景颜色
      * @example 'red'
      */
     backgroundColor?: string;
     /**
-     * 背景边框颜色
      * @description 背景边框颜色
      * @example 'red'
      */
     backgroundBorderColor?: string;
     /**
-     * 背景边框宽度
      * @description 背景边框宽度
      * @example 2
      */
     backgroundBorderWidth?: number;
     /**
-     * 背景边框圆角
      * @description 背景边框圆角
      * @example 4
      */
     backgroundBorderRadius?: number;
     /**
-     * 背景内边距
      * @description 背景内边距
      * @example 4
      */