@visactor/vseed 0.0.31 → 0.0.33

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

@@ -1,126 +1,121 @@
 import { type Selector, type Selectors } from '../../dataSelector';
 import { z } from 'zod';
+/**
+ * @description 垂直标注线, 根据用户设置的selector 或 xValue, 从下向上绘制一条末尾有箭头的线, 标签默认在标注线终点的正左侧
+ */
 export type AnnotationVerticalLine = {
     /**
-     * 依赖选择的数据, 进行数据标记.
+     * @description 依赖选择的数据, 进行数据标记.
      */
     selector?: Selector | Selectors;
     /**
-     * 固定的x值, 用于标注垂直线
-     * @description 类目轴在x方向, 则可输入维值, 数值轴在x方向, 则可输入具体的数值
+     * @description 固定的x值, 用于标注垂直线, 类目轴在x方向, 则可输入维值, 数值轴在x方向, 则可输入具体的数值
      */
     xValue?: (number | string) | (number | string)[];
     /**
-     * 标注的文本
      * @description 标注的文本
      * @default ''
      * @example '标注文本'
      */
     text?: string | string[];
     /**
-     * 文本位置
-     * @description 标注线的标签位置（标签相对线的相对位置）。
+     * @description 文本位置, 标注线的标签位置（标签相对线的相对位置）。
      * @example 'outsideEnd'
      */
     textPosition?: 'outsideStart' | 'outsideEnd' | 'outsideMiddle' | 'insideStart' | 'insideMiddle' | 'insideEnd';
     /**
-     * 文本颜色
      * @description 文本颜色
      * @example 'red'
      */
     textColor?: string;
     /**
-     * 文本字体大小
      * @description 文本字体大小
      * @example 12
      */
     textFontSize?: number;
     /**
-     * 文本字体重量
      * @description 文本字体重量
      * @example 400
      */
     textFontWeight?: number;
     /**
-     * 文本对齐方式
-     * @description 文本对齐方式
-     * @example 'left'
+     * @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;
     /**
-     * 线可见
      * @description 线可见
      * @example true
      */
     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'
      */
     backgroundBorderColor?: string;
     /**
-     * 背景边框宽度
      * @description 背景边框宽度
      * @example 2
      */
     backgroundBorderWidth?: number;
     /**
-     * 背景边框圆角
      * @description 背景边框圆角
      * @example 4
      */
     backgroundBorderRadius?: number;
     /**
-     * 背景内边距
      * @description 背景内边距
      * @example 4
      */
@@ -219,16 +214,16 @@ export declare const zAnnotationVerticalLine: 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>;