@visactor/vseed 0.0.37 → 0.0.38

package/dist/types/chartType/columnParallel/zColumnParallel.d.ts

@@ -640,8 +640,6 @@ export declare const zColumnParallel: z.ZodObject<{
         lineColor: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodString>>>;
         lineWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         lineStyle: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>>;
-        offsetX: z.ZodDefault<z.ZodNumber>;
-        offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>>, z.ZodObject<{
         selector: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
             field: z.ZodString;
@@ -745,8 +743,6 @@ export declare const zColumnParallel: z.ZodObject<{
         lineColor: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodString>>>;
         lineWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         lineStyle: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>>;
-        offsetX: z.ZodDefault<z.ZodNumber>;
-        offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>]>>>;
     annotationHorizontalLine: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodArray<z.ZodObject<{
         selector: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
@@ -851,8 +847,6 @@ export declare const zColumnParallel: z.ZodObject<{
         textBackgroundBorderRadius: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         textBackgroundBorderWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         textBackgroundPadding: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetX: z.ZodDefault<z.ZodNumber>;
-        offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>>, z.ZodObject<{
         selector: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
             field: z.ZodString;
@@ -956,8 +950,6 @@ export declare const zColumnParallel: z.ZodObject<{
         textBackgroundBorderRadius: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         textBackgroundBorderWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         textBackgroundPadding: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetX: z.ZodDefault<z.ZodNumber>;
-        offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>]>>>;
     annotationArea: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodArray<z.ZodObject<{
         selector: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
@@ -1065,8 +1057,6 @@ export declare const zColumnParallel: z.ZodObject<{
         areaBorderWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         areaBorderRadius: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         outerPadding: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetX: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetY: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
     }, z.core.$strip>>, z.ZodObject<{
         selector: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
             field: z.ZodString;
@@ -1173,8 +1163,6 @@ export declare const zColumnParallel: z.ZodObject<{
         areaBorderWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         areaBorderRadius: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         outerPadding: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetX: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetY: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
     }, z.core.$strip>]>>>;
     locale: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodEnum<{
         "zh-CN": "zh-CN";

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

@@ -7,12 +7,16 @@ import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, Annotat
  * - 不同类别数据的占比对比
  * - 多维度数据的构成分析
  * - 时间序列的占比变化趋势
+ * @warning
  * 数据要求:
  * - 至少1个指标字段（度量）
  * - 第一个维度会放至X轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示.
  * - 所有指标会自动合并为一个指标
  * 默认开启的功能:
  * - 默认开启图例、坐标轴、百分比标签、提示信息、占比计算
+ * @recommend
+ * - 推荐字段配置: `1`个指标, `2`个维度
+ * - 支持数据重塑: 至少`1`个指标, `0`个维度
  */
 export interface ColumnPercent {
     /**

package/dist/types/chartType/columnPercent/zColumnPercent.d.ts

@@ -640,8 +640,6 @@ export declare const zColumnPercent: z.ZodObject<{
         lineColor: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodString>>>;
         lineWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         lineStyle: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>>;
-        offsetX: z.ZodDefault<z.ZodNumber>;
-        offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>>, z.ZodObject<{
         selector: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
             field: z.ZodString;
@@ -745,8 +743,6 @@ export declare const zColumnPercent: z.ZodObject<{
         lineColor: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodString>>>;
         lineWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         lineStyle: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>>;
-        offsetX: z.ZodDefault<z.ZodNumber>;
-        offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>]>>>;
     annotationHorizontalLine: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodArray<z.ZodObject<{
         selector: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
@@ -851,8 +847,6 @@ export declare const zColumnPercent: z.ZodObject<{
         textBackgroundBorderRadius: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         textBackgroundBorderWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         textBackgroundPadding: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetX: z.ZodDefault<z.ZodNumber>;
-        offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>>, z.ZodObject<{
         selector: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
             field: z.ZodString;
@@ -956,8 +950,6 @@ export declare const zColumnPercent: z.ZodObject<{
         textBackgroundBorderRadius: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         textBackgroundBorderWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         textBackgroundPadding: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetX: z.ZodDefault<z.ZodNumber>;
-        offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>]>>>;
     annotationArea: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodArray<z.ZodObject<{
         selector: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
@@ -1065,8 +1057,6 @@ export declare const zColumnPercent: z.ZodObject<{
         areaBorderWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         areaBorderRadius: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         outerPadding: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetX: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetY: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
     }, z.core.$strip>>, z.ZodObject<{
         selector: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
             field: z.ZodString;
@@ -1173,8 +1163,6 @@ export declare const zColumnPercent: z.ZodObject<{
         areaBorderWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         areaBorderRadius: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         outerPadding: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetX: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetY: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
     }, z.core.$strip>]>>>;
     locale: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodEnum<{
         "zh-CN": "zh-CN";

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

@@ -7,12 +7,16 @@ import type { BackgroundColor, Color, Dataset, Dimensions, Label, Legend, Measur
  * - 需要同时展示整体数据和各部分占比
  * - 强调数据的整体与部分关系
  * - 中心区域需要展示关键指标或标题
+ * @warning
  * 数据要求:
  * - 至少1个指标字段（度量）
  * - 所有维度会与指标名称(存在多个指标时)合并, 作为图例项展示.
  * - 所有指标会自动合并为一个指标
  * 默认开启的功能:
  * - 默认开启图例、数据标签、提示信息、占比计算、中心文本
+ * @recommend
+ * - 推荐字段配置: `1`个指标, `2`个维度
+ * - 支持数据重塑: 至少`1`个指标, `0`个维度
  */
 export interface Donut {
     /**

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轴.
      */

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

@@ -218,6 +218,7 @@ export declare const zDualAxis: z.ZodObject<{
             scatter: "scatter";
         }>>;
     }, z.core.$strip>]>>>;
+    alignTicks: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodArray<z.ZodBoolean>, z.ZodBoolean]>>>;
     primaryYAxis: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodArray<z.ZodObject<{
         visible: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodBoolean>>>;
         min: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
@@ -1410,8 +1411,6 @@ export declare const zDualAxis: z.ZodObject<{
         lineColor: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodString>>>;
         lineWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         lineStyle: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>>;
-        offsetX: z.ZodDefault<z.ZodNumber>;
-        offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>>, z.ZodObject<{
         selector: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
             field: z.ZodString;
@@ -1515,8 +1514,6 @@ export declare const zDualAxis: z.ZodObject<{
         lineColor: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodString>>>;
         lineWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         lineStyle: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>>;
-        offsetX: z.ZodDefault<z.ZodNumber>;
-        offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>]>>>;
     annotationHorizontalLine: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodArray<z.ZodObject<{
         selector: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
@@ -1621,8 +1618,6 @@ export declare const zDualAxis: z.ZodObject<{
         textBackgroundBorderRadius: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         textBackgroundBorderWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         textBackgroundPadding: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetX: z.ZodDefault<z.ZodNumber>;
-        offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>>, z.ZodObject<{
         selector: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
             field: z.ZodString;
@@ -1726,8 +1721,6 @@ export declare const zDualAxis: z.ZodObject<{
         textBackgroundBorderRadius: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         textBackgroundBorderWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         textBackgroundPadding: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetX: z.ZodDefault<z.ZodNumber>;
-        offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>]>>>;
     annotationArea: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodArray<z.ZodObject<{
         selector: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
@@ -1835,8 +1828,6 @@ export declare const zDualAxis: z.ZodObject<{
         areaBorderWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         areaBorderRadius: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         outerPadding: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetX: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetY: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
     }, z.core.$strip>>, z.ZodObject<{
         selector: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
             field: z.ZodString;
@@ -1943,8 +1934,6 @@ export declare const zDualAxis: z.ZodObject<{
         areaBorderWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         areaBorderRadius: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         outerPadding: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetX: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetY: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
     }, z.core.$strip>]>>>;
     locale: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodEnum<{
         "zh-CN": "zh-CN";

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

@@ -6,12 +6,16 @@ import type { BackgroundColor, ColorLegend, Dataset, Dimensions, Label, LinearCo
  * 适用场景:
  * 漏斗图适用场景:
  * - 适合用来分析具有多个连续、规范化步骤的流程，并清晰地展示在每个环节的数据流失或转化情况
+ * @warning
  * 数据要求:
  * - 至少1个数值字段（指标）
  * - 所有维度会与指标名称(存在多个指标时)合并成一个维度, 作为图例项展示
  * - 所有指标会自动合并为一个指标
  * 默认开启的功能:
  * - 默认开启图例、数据标签、提示信息、占比计算
+ * @recommend
+ * - 推荐字段配置: `1`个指标, `1`个维度
+ * - 支持数据重塑: 至少`1`个指标, `0`个维度
  */
 export interface Funnel {
     /**

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

@@ -8,12 +8,16 @@ import { type BackgroundColor, type Dataset, type Dimensions, type Label, type T
  * - 大规模二维数据的密度和强度展示
  * - 分类与数值的关联分析
  * - 时间序列与类别的交叉对比
+ * @warning
  * 数据要求:
  * - 至少2个维度字段，用于确定热力图的行和列
  * - 至少1个数值字段（度量），用于映射颜色深浅
  * - 支持多个指标时，通常选择一个指标进行颜色映射
  * 默认开启的功能:
  * - 默认开启图例、坐标轴、数据标签、提示信息、数值缩放
+ * @recommend
+ * - 推荐字段配置: `1`个指标, `2`个维度
+ * - 支持数据重塑: 至少`1`个指标, `0`个维度
  */
 export interface Heatmap {
     /**

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

@@ -2,23 +2,29 @@ import type { Locale } from '../../i18n';
 import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, Color, Dataset, Dimensions, Label, Legend, LineStyle, PointStyle, Theme, Tooltip, CrosshairLine, XBandAxis, YLinearAxis, MeasureTree, Sort, SortLegend } from '../../properties';
 /**
  * 折线图类型定义
- * @description 折线图，适用于展示数据随时间或有序类别变化的趋势，通过线段连接数据点形成趋势线
+ * @description
+ * 折线图，适用于展示数据随时间或有序类别变化的趋势，通过线段连接数据点形成趋势线
+ * @warning
  * 适用场景:
  * - 展示时间序列数据的变化趋势
  * - 比较多个数据系列的趋势对比
  * - 分析数据的增长或下降规律
+ * @warning
  * 数据要求:
  * - 至少1个数值字段（度量）
  * - 第一个维度会放至X轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示
  * - 所有指标会自动合并为一个指标
  * 默认开启的功能:
  * - 默认开启图例、坐标轴、数据点标记、提示信息、趋势线
+ * @recommend
+ * - 推荐字段配置: `1`个指标, `2`个维度
+ * - 支持数据重塑: 至少`1`个指标, `0`个维度
  */
 export interface Line {
     /**
      * 折线图
      * @description 折线图，适用于展示数据随时间或有序类别变化的趋势
-     * @type {'line'}
+     * @type {string}
      * @example 'line'
      */
     chartType: 'line';

package/dist/types/chartType/line/zLine.d.ts

@@ -822,8 +822,6 @@ export declare const zLine: z.ZodObject<{
         lineColor: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodString>>>;
         lineWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         lineStyle: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>>;
-        offsetX: z.ZodDefault<z.ZodNumber>;
-        offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>>, z.ZodObject<{
         selector: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
             field: z.ZodString;
@@ -927,8 +925,6 @@ export declare const zLine: z.ZodObject<{
         lineColor: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodString>>>;
         lineWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         lineStyle: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>>;
-        offsetX: z.ZodDefault<z.ZodNumber>;
-        offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>]>>>;
     annotationHorizontalLine: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodArray<z.ZodObject<{
         selector: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
@@ -1033,8 +1029,6 @@ export declare const zLine: z.ZodObject<{
         textBackgroundBorderRadius: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         textBackgroundBorderWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         textBackgroundPadding: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetX: z.ZodDefault<z.ZodNumber>;
-        offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>>, z.ZodObject<{
         selector: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
             field: z.ZodString;
@@ -1138,8 +1132,6 @@ export declare const zLine: z.ZodObject<{
         textBackgroundBorderRadius: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         textBackgroundBorderWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         textBackgroundPadding: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetX: z.ZodDefault<z.ZodNumber>;
-        offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>]>>>;
     annotationArea: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodArray<z.ZodObject<{
         selector: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
@@ -1247,8 +1239,6 @@ export declare const zLine: z.ZodObject<{
         areaBorderWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         areaBorderRadius: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         outerPadding: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetX: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetY: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
     }, z.core.$strip>>, z.ZodObject<{
         selector: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
             field: z.ZodString;
@@ -1355,8 +1345,6 @@ export declare const zLine: z.ZodObject<{
         areaBorderWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         areaBorderRadius: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         outerPadding: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetX: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetY: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
     }, z.core.$strip>]>>>;
     locale: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodEnum<{
         "zh-CN": "zh-CN";

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

@@ -7,12 +7,16 @@ import type { BackgroundColor, Color, Dataset, Dimensions, Label, Legend, Measur
  * - 展示分类数据的占比分布
  * - 强调数据的整体与部分关系
  * - 类别数量较少（建议不超过6个）的占比分析
+ * @warning
  * 数据要求:
  * - 至少1个数值字段（度量）
  * - 所有维度会与指标名称(存在多个指标时)合并成一个维度, 作为图例项展示
  * - 所有指标会自动合并为一个指标
  * 默认开启的功能:
  * - 默认开启图例、数据标签、提示信息、占比计算
+ * @recommend
+ * - 推荐字段配置: `1`个指标, `1`个维度
+ * - 支持数据重塑: 至少`1`个指标, `0`个维度
  */
 export interface Pie {
     /**

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

@@ -8,12 +8,16 @@ import { type BackgroundColor, type Dataset, type Dimensions, type Theme } from
  * - 复杂多维数据统计分析
  * - 数据钻取与聚合展示
  * - 业务报表生成与数据探索
+ * @warning
  * 数据要求:
  * - 至少1个行维度 或 1个列维度 或 1个指标
  * - 数据必须已聚合
  * - 数据可被分组
  * 默认开启的功能:
  * - 默认开启行列排序、数据筛选、聚合计算、小计/总计
+ * @recommend
+ * - 推荐字段配置: `1`个指标, `1`个维度
+ * - 支持数据重塑: 至少`1`个指标, `0`个维度
  */
 export interface PivotTable {
     /**

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

@@ -8,12 +8,16 @@ import { type BackgroundColor, type Color, type Dataset, type Dimensions, type L
  * - 多维度数据的综合表现对比
  * - 多个对象在多个指标上的性能评估
  * - 分类数据的多维度特征展示
+ * @warning
  * 数据要求:
  * - 至少1个数值字段（度量）
  * - 第一个维度作为雷达图的各个维度轴，其他维度作为不同的系列进行对比
  * - 支持多个指标分别作为不同的系列展示
  * 默认开启的功能:
  * - 默认开启图例、雷达坐标系、数据标签、提示信息、数值缩放
+ * @recommend
+ * - 推荐字段配置: `1`个指标, `1`个维度
+ * - 支持数据重塑: 至少`1`个指标, `0`个维度
  */
 export interface Radar {
     /**

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

@@ -8,12 +8,16 @@ import { type BackgroundColor, type Color, type Dataset, type Dimensions, type L
  * - 多维度数据的分布对比
  * - 周期性数据的强弱比较
  * - 分类数据的数值与占比同时展示
+ * @warning
  * 数据要求:
  * - 至少1个数值字段（度量）
  * - 第一个维度会放至角度轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示
  * - 所有指标会自动合并为一个指标
  * 默认开启的功能:
  * - 默认开启图例、极坐标系、数据标签、提示信息、数值缩放
+ * @recommend
+ * - 推荐字段配置: `1`个指标, `1`个维度
+ * - 支持数据重塑: 至少`1`个指标, `0`个维度
  */
 export interface Rose {
     /**

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

@@ -8,12 +8,16 @@ import { type BackgroundColor, type Color, type Dataset, type Dimensions, type L
  * - 多维度数据的分布对比
  * - 周期性数据的强弱比较
  * - 分类数据的数值与占比同时展示
+ * @warning
  * 数据要求:
  * - 至少1个数值字段（度量）
  * - 第一个维度会放至角度轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示
  * - 所有指标会自动合并为一个指标
  * 默认开启的功能:
  * - 默认开启图例、极坐标系、数据标签、提示信息、数值缩放
+ * @recommend
+ * - 推荐字段配置: `1`个指标, `1`个维度
+ * - 支持数据重塑: 至少`1`个指标, `0`个维度
  */
 export interface RoseParallel {
     /**

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

@@ -5,12 +5,16 @@ import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, Annotat
  * @description 散点图，适用于展示数据的分布情况，通过点的位置表示数据的数值
  * 适用场景:
  * - 分析数据的分布特征, 如数据的中心趋势, 分布范围, 异常值等
+ * @warning
  * 数据要求:
  * - 至少2个数值字段（度量）
  * - 第一个指标字段会放至X轴, 其余指标会进行合并, 映射至Y轴
  * - 指标名称和维度名称会合并, 作为图例项展示
  * 默认开启的功能:
  * - 默认开启图例、坐标轴、数据点标记、提示信息、趋势线
+ * @recommend
+ * - 推荐字段配置: `2`个指标, `1`个维度
+ * - 支持数据重塑: 至少`1`个指标, `0`个维度
  */
 export interface Scatter {
     /**

package/dist/types/chartType/scatter/zScatter.d.ts

@@ -648,8 +648,6 @@ export declare const zScatter: z.ZodObject<{
         lineColor: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodString>>>;
         lineWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         lineStyle: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>>;
-        offsetX: z.ZodDefault<z.ZodNumber>;
-        offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>>, z.ZodObject<{
         selector: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
             field: z.ZodString;
@@ -753,8 +751,6 @@ export declare const zScatter: z.ZodObject<{
         lineColor: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodString>>>;
         lineWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         lineStyle: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"solid">, z.ZodLiteral<"dashed">, z.ZodLiteral<"dotted">]>>>>;
-        offsetX: z.ZodDefault<z.ZodNumber>;
-        offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>]>>>;
     annotationHorizontalLine: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodArray<z.ZodObject<{
         selector: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
@@ -859,8 +855,6 @@ export declare const zScatter: z.ZodObject<{
         textBackgroundBorderRadius: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         textBackgroundBorderWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         textBackgroundPadding: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetX: z.ZodDefault<z.ZodNumber>;
-        offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>>, z.ZodObject<{
         selector: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
             field: z.ZodString;
@@ -964,8 +958,6 @@ export declare const zScatter: z.ZodObject<{
         textBackgroundBorderRadius: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         textBackgroundBorderWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         textBackgroundPadding: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetX: z.ZodDefault<z.ZodNumber>;
-        offsetY: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strip>]>>>;
     annotationArea: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodArray<z.ZodObject<{
         selector: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
@@ -1073,8 +1065,6 @@ export declare const zScatter: z.ZodObject<{
         areaBorderWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         areaBorderRadius: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         outerPadding: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetX: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetY: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
     }, z.core.$strip>>, z.ZodObject<{
         selector: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
             field: z.ZodString;
@@ -1181,8 +1171,6 @@ export declare const zScatter: z.ZodObject<{
         areaBorderWidth: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         areaBorderRadius: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
         outerPadding: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetX: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
-        offsetY: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
     }, z.core.$strip>]>>>;
     locale: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodEnum<{
         "zh-CN": "zh-CN";

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

@@ -7,12 +7,16 @@ import { type BackgroundColor, type Dataset, type Theme } from '../../properties
  * - 需要展示详细数据明细
  * - 数据项需要精确比对
  * - 展示多维度数据属性
+ * @warning
  * 数据要求:
  * - 至少1个维度字段
  * - 至少1个度量字段
  * - 维度字段会作为表格的列标题
  * 默认开启的功能:
  * - 默认开启排序、筛选、分页功能
+ * @recommend
+ * - 推荐字段配置: `任意`个指标, `任意`个维度
+ * - 支持数据重塑: 至少`任意`个指标, `任意`个维度
  */
 export interface Table {
     /**

package/dist/types/dataSelector/selector.d.ts

@@ -2,16 +2,70 @@ import { z } from 'zod';
 import type { Datum } from '../properties';
 export type ValueSelector = string | number;
 export type PartialDatumSelector = Datum;
+/**
+ * @description 指标选择器, 用于选择数据项中指标字段的值
+ */
 export type MeasureSelector = {
+    /**
+     * @description 指标字段, measures 某一项的 id
+     */
     field: string;
+    /**
+     * @description 操作符
+     * - =: 选择数据项中指标字段的值等于 value 的数据项
+     * - ==: 选择数据项中指标字段的值等于 value 的数据项
+     * - !=: 选择数据项中指标字段的值不等于 value 的数据项
+     * - >: 选择数据项中指标字段的值大于 value 的数据项
+     * - <: 选择数据项中指标字段的值小于 value 的数据项
+     * - >=: 选择数据项中指标字段的值大于等于 value 的数据项
+     * - <=: 选择数据项中指标字段的值小于等于 value 的数据项
+     * - between: 选择数据项中指标字段的值在 value 之间的 data item
+     */
     operator?: '=' | '==' | '!=' | '>' | '<' | '>=' | '<=' | 'between';
+    /**
+     * @description 操作符
+     * - =: 选择数据项中指标字段的值等于 value 的数据项
+     * - ==: 选择数据项中指标字段的值等于 value 的数据项
+     * - !=: 选择数据项中指标字段的值不等于 value 的数据项
+     * - >: 选择数据项中指标字段的值大于 value 的数据项
+     * - <: 选择数据项中指标字段的值小于 value 的数据项
+     * - >=: 选择数据项中指标字段的值大于等于 value 的数据项
+     * - <=: 选择数据项中指标字段的值小于等于 value 的数据项
+     * - between: 选择数据项中指标字段的值在 value 之间的 data item
+     * same as operator
+     */
     op?: '=' | '==' | '!=' | '>' | '<' | '>=' | '<=' | 'between';
+    /**
+     * @description 选择数据项中指标字段的值
+     * - 仅 op 为 between 时, value 为长度为2的数组, 数组中的元素为指标字段的最小值和最大值
+     * - 其他情况, value 为指标字段的单个值
+     */
     value: string | number | Array<string | number>;
 };
+/**
+ * @description 维度选择器, 用于选择数据项中维度字段的值
+ */
 export type DimensionSelector = {
+    /**
+     * @description 维度字段, dimensions 某一项的 id
+     */
     field: string;
+    /**
+     * @description 操作符
+     * - in: 选择数据项中维度字段的值在 value 中的数据项
+     * - not in: 选择数据项中维度字段的值不在 value 中的数据项
+     */
     operator?: 'in' | 'not in';
+    /**
+     * @description 操作符
+     * - in: 选择数据项中维度字段的值在 value 中的数据项
+     * - not in: 选择数据项中维度字段的值不在 value 中的数据项
+     * same as operator
+     */
     op?: 'in' | 'not in';
+    /**
+     * @description 选择数据项中维度字段的值, 支持数组
+     */
     value: string | number | Array<string | number>;
 };
 export type Selector = ValueSelector | PartialDatumSelector | MeasureSelector | DimensionSelector;