@visactor/vseed 0.0.32 → 0.0.34

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

@@ -217,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
      */

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

@@ -214,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>;

package/dist/types/properties/chartType/dualChartType.d.ts

@@ -0,0 +1,22 @@
+import { z } from 'zod';
+export declare const zDualChartType: z.ZodObject<{
+    primary: z.ZodDefault<z.ZodEnum<{
+        line: "line";
+        column: "column";
+        columnPercent: "columnPercent";
+        columnParallel: "columnParallel";
+        area: "area";
+        areaPercent: "areaPercent";
+        scatter: "scatter";
+    }>>;
+    secondary: z.ZodDefault<z.ZodEnum<{
+        line: "line";
+        column: "column";
+        columnPercent: "columnPercent";
+        columnParallel: "columnParallel";
+        area: "area";
+        areaPercent: "areaPercent";
+        scatter: "scatter";
+    }>>;
+}, z.core.$strip>;
+export type DualChartType = z.infer<typeof zDualChartType>;

package/dist/types/properties/chartType/index.d.ts

@@ -1,2 +1,4 @@
 export type { ChartType } from './chartType';
 export { zChartType } from './chartType';
+export { zDualChartType } from './dualChartType';
+export type { DualChartType } from './dualChartType';