@visactor/vseed 0.0.36 → 0.0.38

package/dist/types/chartType/donut/donut.d.ts

@@ -1,4 +1,3 @@
-import { z } from 'zod';
 import { type Locale } from '../../i18n';
 import type { BackgroundColor, Color, Dataset, Dimensions, Label, Legend, MeasureTree, Theme, Tooltip } from '../../properties';
 /**
@@ -8,12 +7,16 @@ import type { BackgroundColor, Color, Dataset, Dimensions, Label, Legend, Measur
  * - 需要同时展示整体数据和各部分占比
  * - 强调数据的整体与部分关系
  * - 中心区域需要展示关键指标或标题
+ * @warning
  * 数据要求:
  * - 至少1个指标字段（度量）
  * - 所有维度会与指标名称(存在多个指标时)合并, 作为图例项展示.
  * - 所有指标会自动合并为一个指标
  * 默认开启的功能:
  * - 默认开启图例、数据标签、提示信息、占比计算、中心文本
+ * @recommend
+ * - 推荐字段配置: `1`个指标, `2`个维度
+ * - 支持数据重塑: 至少`1`个指标, `0`个维度
  */
 export interface Donut {
     /**
@@ -86,121 +89,3 @@ export interface Donut {
      */
     locale?: Locale;
 }
-export declare const zDonut: z.ZodObject<{
-    chartType: z.ZodLiteral<"donut">;
-    dataset: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodUnion<[z.ZodString, z.ZodNumber]>, z.ZodAny>>>;
-    dimensions: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        id: z.ZodString;
-        alias: z.ZodOptional<z.ZodString>;
-        location: z.ZodDefault<z.ZodEnum<{
-            dimension: "dimension";
-            rowDimension: "rowDimension";
-            columnDimension: "columnDimension";
-        }>>;
-    }, z.core.$strip>>>;
-    measures: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodType<import("../..").MeasureGroup, unknown, z.core.$ZodTypeInternals<import("../..").MeasureGroup, unknown>>, z.ZodObject<{
-        id: z.ZodString;
-        alias: z.ZodOptional<z.ZodString>;
-        autoFormat: z.ZodDefault<z.ZodBoolean>;
-        format: z.ZodDefault<z.ZodOptional<z.ZodObject<{
-            type: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
-                number: "number";
-                percent: "percent";
-                permille: "permille";
-                scientific: "scientific";
-            }>>>;
-            ratio: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-            symbol: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-            thousandSeparator: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-            prefix: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-            suffix: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-            fractionDigits: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-            significantDigits: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-            roundingPriority: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
-                morePrecision: "morePrecision";
-                lessPrecision: "lessPrecision";
-            }>>>;
-            roundingMode: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
-                floor: "floor";
-                ceil: "ceil";
-                expand: "expand";
-                trunc: "trunc";
-                halfCeil: "halfCeil";
-                halfFloor: "halfFloor";
-                halfExpand: "halfExpand";
-                halfTrunc: "halfTrunc";
-                halfEven: "halfEven";
-            }>>>;
-        }, z.core.$strip>>>;
-    }, z.core.$strip>]>>>;
-    backgroundColor: z.ZodOptional<z.ZodOptional<z.ZodDefault<z.ZodString>>>;
-    color: z.ZodOptional<z.ZodObject<{
-        colorScheme: z.ZodOptional<z.ZodArray<z.ZodString>>;
-        colorMapping: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-    }, z.core.$strip>>;
-    label: z.ZodOptional<z.ZodObject<{
-        enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-    }, z.core.$strip>>;
-    legend: z.ZodOptional<z.ZodObject<{
-        enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-        border: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-        maxSize: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-        shapeType: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
-            circle: "circle";
-            cross: "cross";
-            diamond: "diamond";
-            square: "square";
-            arrow: "arrow";
-            arrow2Left: "arrow2Left";
-            arrow2Right: "arrow2Right";
-            wedge: "wedge";
-            thinTriangle: "thinTriangle";
-            triangle: "triangle";
-            triangleUp: "triangleUp";
-            triangleDown: "triangleDown";
-            triangleRight: "triangleRight";
-            triangleLeft: "triangleLeft";
-            stroke: "stroke";
-            star: "star";
-            wye: "wye";
-            rect: "rect";
-            arrowLeft: "arrowLeft";
-            arrowRight: "arrowRight";
-            rectRound: "rectRound";
-            roundLine: "roundLine";
-        }>>>;
-        position: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
-            left: "left";
-            leftTop: "leftTop";
-            leftBottom: "leftBottom";
-            lt: "lt";
-            lb: "lb";
-            top: "top";
-            topLeft: "topLeft";
-            topRight: "topRight";
-            tl: "tl";
-            tr: "tr";
-            right: "right";
-            rightTop: "rightTop";
-            rightBottom: "rightBottom";
-            rt: "rt";
-            rb: "rb";
-            bottom: "bottom";
-            bottomLeft: "bottomLeft";
-            bottomRight: "bottomRight";
-            bl: "bl";
-            br: "br";
-        }>>>;
-        labelFontSize: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
-        labelFontColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-        labelFontWeight: z.ZodOptional<z.ZodDefault<z.ZodUnion<[z.ZodNumber, z.ZodString]>>>;
-    }, z.core.$strip>>;
-    tooltip: z.ZodOptional<z.ZodObject<{
-        enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-    }, z.core.$strip>>;
-    theme: z.ZodOptional<z.ZodString>;
-    locale: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
-        "zh-CN": "zh-CN";
-        "en-US": "en-US";
-    }>>>;
-}, z.core.$strip>;

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

@@ -1 +1,2 @@
-export * from './donut';
+export type * from './donut';
+export * from './zDonut';

package/dist/types/chartType/donut/zDonut.d.ts

@@ -0,0 +1,119 @@
+import { z } from 'zod';
+export declare const zDonut: z.ZodObject<{
+    chartType: z.ZodLiteral<"donut">;
+    dataset: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodRecord<z.ZodUnion<[z.ZodString, z.ZodNumber]>, z.ZodAny>>>>;
+    dimensions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        alias: z.ZodOptional<z.ZodString>;
+        location: z.ZodDefault<z.ZodEnum<{
+            dimension: "dimension";
+            rowDimension: "rowDimension";
+            columnDimension: "columnDimension";
+        }>>;
+    }, z.core.$strip>>>>;
+    measures: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnion<[z.ZodType<import("../..").MeasureGroup, unknown, z.core.$ZodTypeInternals<import("../..").MeasureGroup, unknown>>, z.ZodObject<{
+        id: z.ZodString;
+        alias: z.ZodOptional<z.ZodString>;
+        autoFormat: z.ZodDefault<z.ZodBoolean>;
+        format: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+            type: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+                number: "number";
+                percent: "percent";
+                permille: "permille";
+                scientific: "scientific";
+            }>>>;
+            ratio: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+            symbol: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+            thousandSeparator: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+            prefix: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+            suffix: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+            fractionDigits: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+            significantDigits: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+            roundingPriority: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+                morePrecision: "morePrecision";
+                lessPrecision: "lessPrecision";
+            }>>>;
+            roundingMode: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+                floor: "floor";
+                ceil: "ceil";
+                expand: "expand";
+                trunc: "trunc";
+                halfCeil: "halfCeil";
+                halfFloor: "halfFloor";
+                halfExpand: "halfExpand";
+                halfTrunc: "halfTrunc";
+                halfEven: "halfEven";
+            }>>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>]>>>>;
+    backgroundColor: z.ZodOptional<z.ZodNullable<z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodString>>>>>;
+    color: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        colorScheme: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        colorMapping: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
+    }, z.core.$strip>>>;
+    label: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        enable: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodBoolean>>>;
+    }, z.core.$strip>>>;
+    legend: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        enable: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodBoolean>>>;
+        border: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodBoolean>>>;
+        maxSize: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
+        shapeType: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodEnum<{
+            circle: "circle";
+            cross: "cross";
+            diamond: "diamond";
+            square: "square";
+            arrow: "arrow";
+            arrow2Left: "arrow2Left";
+            arrow2Right: "arrow2Right";
+            wedge: "wedge";
+            thinTriangle: "thinTriangle";
+            triangle: "triangle";
+            triangleUp: "triangleUp";
+            triangleDown: "triangleDown";
+            triangleRight: "triangleRight";
+            triangleLeft: "triangleLeft";
+            stroke: "stroke";
+            star: "star";
+            wye: "wye";
+            rect: "rect";
+            arrowLeft: "arrowLeft";
+            arrowRight: "arrowRight";
+            rectRound: "rectRound";
+            roundLine: "roundLine";
+        }>>>>;
+        position: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodEnum<{
+            left: "left";
+            leftTop: "leftTop";
+            leftBottom: "leftBottom";
+            lt: "lt";
+            lb: "lb";
+            top: "top";
+            topLeft: "topLeft";
+            topRight: "topRight";
+            tl: "tl";
+            tr: "tr";
+            right: "right";
+            rightTop: "rightTop";
+            rightBottom: "rightBottom";
+            rt: "rt";
+            rb: "rb";
+            bottom: "bottom";
+            bottomLeft: "bottomLeft";
+            bottomRight: "bottomRight";
+            bl: "bl";
+            br: "br";
+        }>>>>;
+        labelFontSize: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
+        labelFontColor: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodString>>>;
+        labelFontWeight: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodUnion<[z.ZodNumber, z.ZodString]>>>>;
+    }, z.core.$strip>>>;
+    tooltip: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        enable: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodBoolean>>>;
+    }, z.core.$strip>>>;
+    theme: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    locale: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodEnum<{
+        "zh-CN": "zh-CN";
+        "en-US": "en-US";
+    }>>>>;
+}, z.core.$strip>;

package/dist/types/chartType/dualAxis/dualAxis.d.ts

@@ -8,6 +8,7 @@ import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, Annotat
  * - 相关性指标的趋势比较
  * - 需要同时展示数值和增长率等复合指标
  * - 支持不同类型图表组合（如折线图+柱状图/ 折线图+面积图/ 面积图+柱状图）
+ * @warning
  * 数据要求:
  * - 至少1个指标字段（度量）
  * - 支持指标组, 第一组指标会放置(主轴)左轴, 第二组指标会放置(次轴)右轴
@@ -15,6 +16,9 @@ import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, Annotat
  * - 两组指标字段可分别映射到左右两个Y轴, 一个指标组内的所有会自动合并为一个指标
  * 默认开启的功能:
  * - 默认开启坐标轴、图例、数据标签、提示信息
+ * @recommend
+ * - 推荐字段配置: `2`个指标, `2`个维度
+ * - 支持数据重塑: 至少`1`个指标, `0`个维度
  */
 export interface DualAxis {
     /**
@@ -121,6 +125,11 @@ export interface DualAxis {
      * [{primary: 'line', secondary: 'bar'}, {primary: 'column', secondary: 'area'}]
      */
     dualChartType?: DualChartType | DualChartType[];
+    /**
+     * @description 用于定义双轴图的两根轴的刻度是否对齐, 当measures有多组时, alignTicks可以配置为数组, 每项对应一个双轴图的刻度是否对齐.
+     * @example {"chartType":"dualAxis","dataset":[{"date":"2019","profit":10,"sales":100},{"date":"2020","profit":30,"sales":200},{"date":"2021","profit":30,"sales":300},{"date":"2022","profit":50,"sales":500}],"alignTicks":[false,true],"dualMeasures":[{"primaryMeasures":[{"id":"profit"}],"secondaryMeasures":[{"id":"sales"}]},{"primaryMeasures":[{"id":"profit"}],"secondaryMeasures":[{"id":"sales"}]}]}
+     */
+    alignTicks?: boolean | boolean[];
     /**
      * @description 双轴图的主Y轴配置, 用于定义双轴图的主Y轴, 包括主Y轴的位置, 样式等. 当measures有多组时, primaryYAxis可以配置为数组, 每项对应一个双轴图的主Y轴.
      */