@visactor/vseed 0.1.6 → 0.1.8

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

@@ -1,29 +1,19 @@
 import type { Locale } from '../../i18n';
-import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XBandAxis, YLinearAxis, MeasureTree, SortLegend, Sort, Encoding } from '../../properties';
+import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XBandAxis, YLinearAxis, MeasureTree, SortLegend, Sort } from '../../properties';
 /**
- * 并列柱状图类型定义
  * @description 并列柱状图，适用于多指标并行对比场景，多个柱子并列排列展示不同指标值
  * 适用场景:
  * - 同一维度下多指标并行对比
  * - 多维度数据的横向比较
  * - 指标间关联性分析
- * @info
- * 维度未包含任何encoding, 则使用默认映射规则:
- * 1. x: 第一个维度映射至X轴
- * 2. color: 非X轴所有维度与指标名称, 合并映射至颜色通道, 作为图例展示
- * 3. detail: 其余所有维度映射至Detail通道
- * 指标未包含任何encoding, 则使用默认映射规则:
- * 1. y: 全部指标映射至Y轴
- * 2. tooltip: 全部指标映射至Tooltip
- *
- * 维度映射规则:
- * 1. 用户指定的xAxis维度映射至X轴, 支持多个维度; 若未指定, 则默认映射第一个维度
- * 2. 用户指定的color维度映射至颜色通道, 支持多个维度; 若未指定, 则默认映射指标名称
- * 3. 用户指定的detail维度映射至Detail通道, 支持多个维度; 若未指定, 则无detail
- * 指标映射规则:
- * 1. 指标未配置encoding, 则默认映射至Y轴;
- * 2. 用户指定的yAxis指标映射至Y轴, 支持多个指标;
- * 3. 所有指标均映射到Tooltip
+ * @encoding
+ * 并列柱状图支持以下视觉通道:
+ * `xAxis`  : x轴通道, 支持`多个维度`, 按维度值映射至x轴
+ * `yAxis`  : y轴通道, 支持`多个指标`, 按指标值映射至y轴
+ * `detail` : 细分通道, 支持`多个维度`, 在同一个颜色系列下展示更细粒度的数据时使用
+ * `color`  : 颜色通道, 支持`多个维度`或 `一个指标`, 维度颜色用于区分不同的数据系列, 指标颜色用于线性映射指标值到图形颜色
+ * `tooltip`: 提示通道, 支持`多个维度`与 `多个指标`, 会在鼠标悬停在数据点上时展示
+ * `label`  : 标签通道, 支持`多个维度`与 `多个指标`, 会在数据点上展示数据标签
  * @warning
  * 数据要求:
  * - 至少1个指标字段（度量）
@@ -46,18 +36,6 @@ export interface ColumnParallel {
      * @example [{category:'A', value1:100, value2:200}, {category:'B', value1:150, value2:250}]
      */
     dataset: Dataset;
-    /**
-     * @description 编码配置, 并列柱状图的视觉通道, 包括: x通道, color通道, detail通道, label通道, tooltip通道
-     * - x: 映射到X轴的字段, 支持放入多个维度
-     * - detail: 细分映射通道, 支持放入多个维度
-     * - tooltip: 提示映射通道, 支持放入多个维度 和 多个指标
-     * - color: 颜色映射通道, 支持放入多个维度 或 1个 指标
-     * - label: 标签映射通道, 支持放入 多个维度 或 多个指标
-     *
-     * @tip 特殊的:
-     * - y: measures会直接映射到Y轴通道
-     */
-    encoding?: Pick<Encoding, 'x' | 'color' | 'detail' | 'label' | 'tooltip'>;
     /**
      * @description 维度, 第一个维度被映射到X轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示.
      * @type {Dimensions}
@@ -67,7 +45,7 @@ export interface ColumnParallel {
     /**
      * @description 指标, 并列柱状图的所有指标会自动合并为一个指标, 映射到Y轴, 存在多个指标时, 指标名称会与其余维度合并, 作为图例项展示.
      * @type {DimensionTree}
-     * @example [{id: 'value1', alias: '指标1'}, {id: 'value2', alias: '指标2'}]
+   Axis  * @example [{id: 'value1', alias: '指标1'}, {id: 'value2', alias: '指标2'}]
      */
     measures?: MeasureTree;
     /**

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

@@ -19,11 +19,6 @@ export declare const zColumnParallel: z.ZodObject<{
     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";
-        }>>;
         encoding: z.ZodOptional<z.ZodEnum<{
             column: "column";
             xAxis: "xAxis";

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

@@ -1,28 +1,19 @@
 import type { Locale } from '../../i18n';
-import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XBandAxis, YLinearAxis, MeasureTree, Sort, SortLegend, Encoding } from '../../properties';
+import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XBandAxis, YLinearAxis, MeasureTree, Sort, SortLegend } from '../../properties';
 /**
  * @description 百分比柱状图，适用于展示各类别占比关系的场景，Y轴以百分比形式展示数据占比
  * 适用场景:
  * - 不同类别数据的占比对比
  * - 多维度数据的构成分析
  * - 时间序列的占比变化趋势
- * @info
- * 维度未包含任何encoding, 则使用默认映射规则:
- * 1. x: 第一个维度映射至X轴
- * 2. color: 非X轴所有维度与指标名称, 合并映射至颜色通道, 作为图例展示
- * 3. detail: 其余所有维度映射至Detail通道
- * 指标未包含任何encoding, 则使用默认映射规则:
- * 1. y: 全部指标映射至Y轴
- * 2. tooltip: 全部指标映射至Tooltip
- *
- * 维度映射规则:
- * 1. 用户指定的xAxis维度映射至X轴, 支持多个维度; 若未指定, 则默认映射第一个维度
- * 2. 用户指定的color维度映射至颜色通道, 支持多个维度; 若未指定, 则默认映射指标名称
- * 3. 用户指定的detail维度映射至Detail通道, 支持多个维度; 若未指定, 则无detail
- * 指标映射规则:
- * 1. 指标未配置encoding, 则默认映射至Y轴;
- * 2. 用户指定的yAxis指标映射至Y轴, 支持多个指标;
- * 3. 所有指标均映射到Tooltip
+ * @encoding
+ * 百分比柱状图支持以下视觉通道:
+ * `xAxis`  : x轴通道, 支持`多个维度`, 按维度值映射至x轴
+ * `yAxis`  : y轴通道, 支持`多个指标`, 按指标值映射至y轴
+ * `detail` : 细分通道, 支持`多个维度`, 在同一个颜色系列下展示更细粒度的数据时使用
+ * `color`  : 颜色通道, 支持`多个维度`或 `一个指标`, 维度颜色用于区分不同的数据系列, 指标颜色用于线性映射指标值到图形颜色
+ * `tooltip`: 提示通道, 支持`多个维度`与 `多个指标`, 会在鼠标悬停在数据点上时展示
+ * `label`  : 标签通道, 支持`多个维度`与 `多个指标`, 会在数据点上展示数据标签
  * @warning
  * 数据要求:
  * - 至少1个指标字段（度量）
@@ -49,18 +40,6 @@ export interface ColumnPercent {
      * @example [{category:'A', value:30}, {category:'B', value:70}]
      */
     dataset: Dataset;
-    /**
-     * @description 编码配置, 百分比柱状图的视觉通道, 包括: x通道, color通道, detail通道, label通道, tooltip通道
-     * - x: 映射到X轴的字段, 支持放入多个维度
-     * - detail: 细分映射通道, 支持放入多个维度
-     * - tooltip: 提示映射通道, 支持放入多个维度 和 多个指标
-     * - color: 颜色映射通道, 支持放入多个维度 或 1个 指标
-     * - label: 标签映射通道, 支持放入 多个维度 或 多个指标
-     *
-     * @tip 特殊的:
-     * - y: measures会直接映射到Y轴通道
-     */
-    encoding?: Pick<Encoding, 'x' | 'color' | 'detail' | 'label' | 'tooltip'>;
     /**
      * 维度
      * @description 第一个维度被映射到X轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示.

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

@@ -19,11 +19,6 @@ export declare const zColumnPercent: z.ZodObject<{
     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";
-        }>>;
         encoding: z.ZodOptional<z.ZodEnum<{
             column: "column";
             xAxis: "xAxis";

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

@@ -1,12 +1,18 @@
 import { type Locale } from '../../i18n';
-import type { BackgroundColor, Color, Dataset, Dimensions, Encoding, Label, Legend, MeasureTree, Theme, Tooltip } from '../../properties';
+import type { BackgroundColor, Color, Dataset, Dimensions, Label, Legend, MeasureTree, Theme, Tooltip } from '../../properties';
 /**
- * 环形图类型定义
  * @description 环形图，适用于展示单一维度数据的占比关系，中心留有空白区域可展示汇总信息
  * 适用场景:
  * - 需要同时展示整体数据和各部分占比
  * - 强调数据的整体与部分关系
  * - 中心区域需要展示关键指标或标题
+ * @encoding
+ * 环形图支持以下视觉通道:
+ * `angle`  : 角度通道, 支持`多个指标`, 按指标值映射至扇形角度
+ * `detail` : 细分通道, 支持`多个维度`, 在同一个颜色系列下展示更细粒度的数据时使用
+ * `color`  : 颜色通道, 支持`多个维度`或 `一个指标`, 维度颜色用于区分不同的数据系列, 指标颜色用于线性映射指标值到图形颜色
+ * `tooltip`: 提示通道, 支持`多个维度`与 `多个指标`, 会在鼠标悬停在数据点上时展示
+ * `label`  : 标签通道, 支持`多个维度`与 `多个指标`, 会在数据点上展示数据标签
  * @warning
  * 数据要求:
  * - 至少1个指标字段（度量）
@@ -33,17 +39,6 @@ export interface Donut {
      * @example [{category:'A', value:30}, {category:'B', value:70}]
      */
     dataset: Dataset;
-    /**
-     * @description 编码配置, 环形图的视觉通道, 包括: color通道, detail通道, label通道, tooltip通道
-     * - color: 颜色映射通道, 支持放入多个维度 或 1个 指标
-     * - detail: 细分映射通道, 支持放入多个维度
-     * - tooltip: 提示映射通道, 支持放入多个维度 和 多个指标
-     * - label: 标签映射通道, 支持放入 多个维度 或 多个指标
-     *
-     * @tip 特殊的:
-     * - angle: measures会直接映射到角度通道
-     */
-    encoding?: Pick<Encoding, 'color' | 'detail' | 'label' | 'tooltip'>;
     /**
      * 维度
      * @description 环形图的所有维度会与指标名称(存在多个指标时)合并成1个维度, 映射到饼图的角度, 并作为图例项展示.

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

@@ -19,11 +19,6 @@ export declare const zDonut: z.ZodObject<{
     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";
-        }>>;
         encoding: z.ZodOptional<z.ZodEnum<{
             column: "column";
             xAxis: "xAxis";

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

@@ -1,13 +1,21 @@
 import type { Locale } from '../../i18n';
-import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, AreaStyle, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, DualChartType, DualMeasures, Encoding, Label, Legend, LineStyle, MeasureTree, PointStyle, Sort, SortLegend, Theme, Tooltip, YLinearAxis } from '../../properties';
+import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, AreaStyle, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, DualChartType, DualMeasures, Label, Legend, LineStyle, MeasureTree, PointStyle, Sort, SortLegend, Theme, Tooltip, YLinearAxis } from '../../properties';
 /**
- * 双轴图类型定义
  * @description 双轴图，适用于展示两个不同量级或不同单位指标的对比关系，包含主坐标轴和次坐标轴
  * 适用场景:
  * - 不同量级指标的对比分析
  * - 相关性指标的趋势比较
  * - 需要同时展示数值和增长率等复合指标
  * - 支持不同类型图表组合（如折线图+柱状图/ 折线图+面积图/ 面积图+柱状图）
+ * @encoding
+ * 双轴图支持以下视觉通道:
+ * `xAxis`          : x轴通道, 支持`多个维度`, 按维度值映射至x轴
+ * `primaryYAxis`   : 主轴y轴通道, 支持`多个指标`, 将指标映射至主轴
+ * `secondaryYAxis` : 次轴y轴通道, 支持`多个指标`, 将指标映射至次轴
+ * `detail`         : 细分通道, 支持`多个维度`, 在同一个颜色系列下展示更细粒度的数据时使用
+ * `color`          : 颜色通道, 支持`多个维度`或 `一个指标`, 维度颜色用于区分不同的数据系列, 指标颜色用于线性映射指标值到图形颜色
+ * `tooltip`        : 提示通道, 支持`多个维度`与 `多个指标`, 会在鼠标悬停在数据点上时展示
+ * `label`          : 标签通道, 支持`多个维度`与 `多个指标`, 会在数据点上展示数据标签
  * @warning
  * 数据要求:
  * - 至少1个指标字段（度量）
@@ -31,18 +39,6 @@ export interface DualAxis {
      * @example [{month:'1月', value:100, growth:0.2}, {month:'2月', value:150, growth:0.5}]
      */
     dataset: Dataset;
-    /**
-     * @description 编码配置, 双轴图的视觉通道, 包括: x通道, color通道, detail通道, label通道, tooltip通道
-     * - detail: 细分映射通道, 支持放入多个维度
-     * - tooltip: 提示映射通道, 支持放入多个维度 和 多个指标
-     * - color: 颜色映射通道, 支持放入多个维度 或 1个 指标
-     * - label: 标签映射通道, 支持放入 多个维度 或 多个指标
-     *
-     * @tip 特殊的:
-     * - primaryY: measures会直接映射到主Y轴通道
-     * - secondaryY: measures会直接映射到次Y轴通道
-     */
-    encoding?: Pick<Encoding, 'x' | 'color' | 'detail' | 'label' | 'tooltip'>;
     /**
      * @description 维度, 第一个维度会放至X轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示.
      * @example [{id: 'month', alias: '月份'}]

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

@@ -5,11 +5,6 @@ export declare const zDualAxis: z.ZodObject<{
     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";
-        }>>;
         encoding: z.ZodOptional<z.ZodEnum<{
             column: "column";
             xAxis: "xAxis";

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

@@ -1,11 +1,17 @@
 import type { Locale } from '../../i18n';
-import type { BackgroundColor, ColorLegend, Dataset, Dimensions, Encoding, Label, LinearColor, MeasureTree, Theme, Tooltip } from '../../properties';
+import type { BackgroundColor, ColorLegend, Dataset, Dimensions, Label, LinearColor, MeasureTree, Theme, Tooltip } from '../../properties';
 /**
- * 漏斗图
  * @description 漏斗图，用于展示单一维度数据的占比关系
  * 适用场景:
  * 漏斗图适用场景:
  * - 适合用来分析具有多个连续、规范化步骤的流程，并清晰地展示在每个环节的数据流失或转化情况
+ * @encoding
+ * 漏斗图支持以下视觉通道:
+ * `size`   : 大小通道, 支持`多个指标`, 按指标值映射至漏斗宽度
+ * `detail` : 细分通道, 支持`多个维度`, 在同一个颜色系列下展示更细粒度的数据时使用
+ * `color`  : 颜色通道, 支持`多个维度`或 `一个指标`, 维度颜色用于区分不同的数据系列, 指标颜色用于线性映射指标值到图形颜色
+ * `tooltip`: 提示通道, 支持`多个维度`与 `多个指标`, 会在鼠标悬停在数据点上时展示
+ * `label`  : 标签通道, 支持`多个维度`与 `多个指标`, 会在数据点上展示数据标签
  * @warning
  * 数据要求:
  * - 至少1个数值字段（指标）
@@ -32,17 +38,6 @@ export interface Funnel {
      * @example [{category:'A', value:30}, {category:'B', value:70}]
      */
     dataset: Dataset;
-    /**
-     * @description 编码配置,漏斗图的视觉通道, 包括: color通道, detail通道, label通道, tooltip通道
-     * - detail: 细分映射通道, 支持放入多个维度
-     * - tooltip: 提示映射通道, 支持放入多个维度 和 多个指标
-     * - color: 颜色映射通道, 支持放入多个维度 或 1个 指标
-     * - label: 标签映射通道, 支持放入 多个维度 或 多个指标
-     *
-     * @tip 特殊的:
-     * - size: measures会直接映射到尺寸通道
-     */
-    encoding?: Pick<Encoding, 'color' | 'detail' | 'label' | 'tooltip'>;
     /**
      * 维度
      * @description 漏斗图的所有维度会与指标名称(存在多个指标时)合并成一个维度,并作为图例项展示

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

@@ -19,11 +19,6 @@ export declare const zFunnel: z.ZodObject<{
     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";
-        }>>;
         encoding: z.ZodOptional<z.ZodEnum<{
             column: "column";
             xAxis: "xAxis";

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

@@ -1,13 +1,20 @@
 import { type Locale } from '../../i18n';
-import type { ColorLegend, Encoding, LinearColor, MeasureTree } from '../../properties';
+import type { ColorLegend, LinearColor, MeasureTree } from '../../properties';
 import { type BackgroundColor, type Dataset, type Dimensions, type Label, type Theme, type Tooltip } from '../../properties';
 /**
- * 热力图类型定义
  * @description 热力图，通过二维矩阵的颜色深浅展示数据的分布和强弱关系
  * 适用场景:
  * - 大规模二维数据的密度和强度展示
  * - 分类与数值的关联分析
  * - 时间序列与类别的交叉对比
+ * @encoding
+ * 热力图支持以下视觉通道:
+ * `xAxis`      : x轴通道, 支持`多个维度`, 按维度值映射至x轴
+ * `yAxis`      : y轴通道, 支持`多个维度`, 按维度值映射至y轴
+ * `detail` : 细分通道, 支持`多个维度`, 在同一个颜色系列下展示更细粒度的数据时使用
+ * `color`  : 颜色通道, 支持`一个指标`, 按指标值映射至颜色
+ * `tooltip`: 提示通道, 支持`多个维度`与 `多个指标`, 会在鼠标悬停在数据点上时展示
+ * `label`  : 标签通道, 支持`多个维度`与 `多个指标`, 会在数据点上展示数据标签
  * @warning
  * 数据要求:
  * - 至少2个维度字段，用于确定热力图的行和列
@@ -34,18 +41,6 @@ export interface Heatmap {
      * @example [{month:'1月', value:100}, {month:'2月', value:150}, {month:'3月', value:120}]
      */
     dataset: Dataset;
-    /**
-     * @description 编码配置, 热力图的视觉通道, 包括: x通道, y通道, color通道, label通道, tooltip通道
-     * - x: x轴映射通道, 支持放入多个维度
-     * - y: y轴映射通道, 支持放入多个维度
-     * - tooltip: 提示映射通道, 支持放入多个维度 和 多个指标
-     * - color: 颜色映射通道, 支持放入多个维度 或 1个 指标
-     * - label: 标签映射通道, 支持放入 多个维度 或 多个指标
-     *
-     * @tip 特殊的:
-     * - value: measures会直接映射到数值通道
-     */
-    encoding?: Pick<Encoding, 'color' | 'x' | 'y' | 'label' | 'tooltip'>;
     /**
      * 维度
      * @description 热力图的第一个维度被映射到角度轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示.

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

@@ -5,11 +5,6 @@ export declare const zHeatmap: z.ZodObject<{
     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";
-        }>>;
         encoding: z.ZodOptional<z.ZodEnum<{
             column: "column";
             xAxis: "xAxis";

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

@@ -1,30 +1,18 @@
 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, Encoding } from '../../properties';
+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
- * 折线图，适用于展示数据随时间或有序类别变化的趋势，通过线段连接数据点形成趋势线
- * @info
- * Encoding规则
- * 维度未包含任何encoding, 则使用默认映射规则:
- * 1. x: 第一个维度映射至X轴
- * 2. color: 其余所有维度与指标名称, 合并映射至颜色通道, 作为图例展示
- * 指标未包含任何encoding, 则使用默认映射规则:
- * 1. y: 全部指标映射至Y轴
- * 2. tooltip: 全部指标映射至Tooltip
- *
- * 维度映射规则:
- * 1. 用户指定的xAxis维度映射至X轴, 支持多个维度; 若未指定, 则默认映射第一个维度
- * 2. 用户指定的color维度映射至颜色通道, 支持多个维度; 若未指定, 则默认映射指标名称
- * 指标映射规则:
- * 1. 指标未配置encoding, 则默认映射至Y轴;
- * 2. 用户指定的yAxis指标映射至Y轴, 支持多个指标;
- * 3. 所有指标均映射到Tooltip
- * @warning
+ * @description 折线图，适用于展示数据随时间或有序类别变化的趋势，通过线段连接数据点形成趋势线
  * 适用场景:
  * - 展示时间序列数据的变化趋势
  * - 比较多个数据系列的趋势对比
  * - 分析数据的增长或下降规律
+ * @encoding
+ * 折线图支持以下视觉通道:
+ * `x`      : x轴通道, 支持`多个维度`, 按维度值映射至x轴
+ * `y`      : y轴通道, 支持`多个指标`, 按指标值映射至y轴
+ * `color`  : 颜色通道, 支持`多个维度`或 `一个指标`, 维度颜色用于区分不同的数据系列, 指标颜色用于线性映射指标值到图形颜色
+ * `tooltip`: 提示通道, 支持`多个维度`与 `多个指标`, 会在鼠标悬停在数据点上时展示
+ * `label`  : 标签通道, 支持`多个维度`与 `多个指标`, 会在数据点上展示数据标签
  * @warning
  * 数据要求:
  * - 至少1个数值字段（度量）
@@ -49,18 +37,6 @@ export interface Line {
      * @example [{month:'1月', value:100}, {month:'2月', value:150}, {month:'3月', value:120}]
      */
     dataset: Dataset;
-    /**
-     * @description 编码配置, 折线图的视觉通道, 包括: x通道, color通道, detail通道, label通道, tooltip通道
-     * - x: 映射到X轴的字段, 支持放入多个维度
-     * - detail: 细分映射通道, 支持放入多个维度
-     * - tooltip: 提示映射通道, 支持放入多个维度 和 多个指标
-     * - color: 颜色映射通道, 支持放入多个维度 或 1个 指标
-     * - label: 标签映射通道, 支持放入 多个维度 或 多个指标
-     *
-     * @tip 特殊的:
-     * - y: measures会直接映射到Y轴通道
-     */
-    encoding?: Pick<Encoding, 'x' | 'color' | 'detail' | 'label' | 'tooltip'>;
     /**
      * @description 维度, 折线图的第一个维度被映射到X轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示
      * @type {Dimensions}

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

@@ -19,11 +19,6 @@ export declare const zLine: z.ZodObject<{
     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";
-        }>>;
         encoding: z.ZodOptional<z.ZodEnum<{
             column: "column";
             xAxis: "xAxis";

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

@@ -1,12 +1,18 @@
 import type { Locale } from '../../i18n';
-import type { BackgroundColor, Color, Dataset, Dimensions, Encoding, Label, Legend, MeasureTree, Theme, Tooltip } from '../../properties';
+import type { BackgroundColor, Color, Dataset, Dimensions, Label, Legend, MeasureTree, Theme, Tooltip } from '../../properties';
 /**
- * 饼图类型定义
  * @description 饼图，适用于展示单一维度数据的占比关系，通过扇形面积大小表示各类别占比
  * 适用场景:
  * - 展示分类数据的占比分布
  * - 强调数据的整体与部分关系
  * - 类别数量较少（建议不超过6个）的占比分析
+ * @encoding
+ * 饼图支持以下视觉通道:
+ * `angle`  : 角度通道, 支持`多个指标`, 按指标值映射至扇形角度
+ * `detail` : 细分通道, 支持`多个维度`, 在同一个颜色系列下展示更细粒度的数据时使用
+ * `color`  : 颜色通道, 支持`多个维度`或 `一个指标`, 维度颜色用于区分不同的数据系列, 指标颜色用于线性映射指标值到图形颜色
+ * `tooltip`: 提示通道, 支持`多个维度`与 `多个指标`, 会在鼠标悬停在数据点上时展示
+ * `label`  : 标签通道, 支持`多个维度`与 `多个指标`, 会在数据点上展示数据标签
  * @warning
  * 数据要求:
  * - 至少1个数值字段（度量）
@@ -33,17 +39,6 @@ export interface Pie {
      * @example [{category:'A', value:30}, {category:'B', value:70}]
      */
     dataset: Dataset;
-    /**
-     * @description 编码配置, 饼图的视觉通道, 包括: color通道, detail通道, label通道, tooltip通道
-     * - detail: 细分映射通道, 支持放入多个维度
-     * - tooltip: 提示映射通道, 支持放入多个维度 和 多个指标
-     * - color: 颜色映射通道, 支持放入多个维度 或 1个 指标
-     * - label: 标签映射通道, 支持放入 多个维度 或 多个指标
-     *
-     * @tip 特殊的:
-     * - angle: measures会直接映射到角度通道
-     */
-    encoding?: Pick<Encoding, 'color' | 'detail' | 'label' | 'tooltip'>;
     /**
      * 维度
      * @description 饼图的所有维度会与指标名称(存在多个指标时)合并成一个维度, 映射到角度, 并作为图例项展示

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

@@ -19,11 +19,6 @@ export declare const zPie: z.ZodObject<{
     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";
-        }>>;
         encoding: z.ZodOptional<z.ZodEnum<{
             column: "column";
             xAxis: "xAxis";

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

@@ -2,12 +2,16 @@ import { type Locale } from '../../i18n';
 import type { Measures } from '../../properties';
 import { type BackgroundColor, type Dataset, type Dimensions, type Theme } from '../../properties';
 /**
- * 透视表类型定义
- * @description 透视表，适用于多维度数据交叉分析场景，可灵活配置行、列维度和指标计算方式
+ * @description 透视表格，适用于多维度数据交叉分析场景，可灵活配置行、列维度和指标计算方式
  * 适用场景:
  * - 复杂多维数据统计分析
  * - 数据钻取与聚合展示
  * - 业务报表生成与数据探索
+ * @encoding
+ * 透视表支持以下视觉通道:
+ * `row`    : 行维度, 支持`多个维度`, 按维度值在行上进行分组
+ * `column` : 列维度, 支持`多个维度`, 按维度值在列上进行分组
+ * `detail` : 细分通道, 支持`多个指标`, 在单元格中展示指标值
  * @warning
  * 数据要求:
  * - 至少1个行维度 或 1个列维度 或 1个指标
@@ -33,7 +37,7 @@ export interface PivotTable {
      */
     dataset: Dataset;
     /**
-     * @description 透视表的行维度和列维度，会自动对数据进行处理为树形结构, 并映射到行和列轴, 可以通过 location : "rowDimension" | "columnDimension" 来控制一维度的映射位置
+     * @description 透视表的行维度和列维度，会自动对数据进行处理为树形结构, 并映射到行和列轴,
      * @type {Dimensions}
      * @example [{id: 'region', alias: '地区', isRow: true}, {id: 'product', alias: '产品', isColumn: true}]
      */

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

@@ -5,11 +5,6 @@ export declare const zPivotTable: z.ZodObject<{
     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";
-        }>>;
         encoding: z.ZodOptional<z.ZodEnum<{
             column: "column";
             xAxis: "xAxis";

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

@@ -1,13 +1,19 @@
 import { type Locale } from '../../i18n';
-import type { AreaStyle, Encoding, LineStyle, MeasureTree, PointStyle } from '../../properties';
+import type { AreaStyle, LineStyle, MeasureTree, PointStyle } from '../../properties';
 import { type BackgroundColor, type Color, type Dataset, type Dimensions, type Label, type Legend, type Theme, type Tooltip } from '../../properties';
 /**
- * 雷达图类型定义
  * @description 雷达图，适用于多维度数据的对比分析，通过多轴坐标系展示各维度的数值分布
  * 适用场景:
  * - 多维度数据的综合表现对比
  * - 多个对象在多个指标上的性能评估
  * - 分类数据的多维度特征展示
+ * @encoding
+ * 雷达图支持以下视觉通道:
+ * `angle`  : 角度通道, 支持`多个维度`, 按维度值映射至角度轴
+ * `radius` : 半径通道, 支持`多个指标`, 按指标值映射至半径轴
+ * `color`  : 颜色通道, 支持`多个维度`或 `一个指标`, 维度颜色用于区分不同的数据系列, 指标颜色用于线性映射指标值到图形颜色
+ * `tooltip`: 提示通道, 支持`多个维度`与 `多个指标`, 会在鼠标悬停在数据点上时展示
+ * `label`  : 标签通道, 支持`多个维度`与 `多个指标`, 会在数据点上展示数据标签
  * @warning
  * 数据要求:
  * - 至少1个数值字段（度量）
@@ -34,18 +40,6 @@ export interface Radar {
      * @example [{month:'1月', value:100}, {month:'2月', value:150}, {month:'3月', value:120}]
      */
     dataset: Dataset;
-    /**
-     * @description 编码配置, 雷达图的视觉通道, 包括: angle通道, color通道, detail通道, label通道, tooltip通道
-     * - angle: 映射到角度的字段, 支持放入多个维度
-     * - detail: 细分映射通道, 支持放入多个维度
-     * - tooltip: 提示映射通道, 支持放入多个维度 和 多个指标
-     * - color: 颜色映射通道, 支持放入多个维度 或 1个 指标
-     * - label: 标签映射通道, 支持放入 多个维度 或 多个指标
-     *
-     * @tip 特殊的:
-     * - radius: measures会直接映射到半径通道
-     */
-    encoding?: Pick<Encoding, 'angle' | 'color' | 'detail' | 'label' | 'tooltip'>;
     /**
      * 维度
      * @description 雷达图的第一个维度被映射到角度轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示.

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

@@ -19,11 +19,6 @@ export declare const zRadar: z.ZodObject<{
     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";
-        }>>;
         encoding: z.ZodOptional<z.ZodEnum<{
             column: "column";
             xAxis: "xAxis";

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

@@ -1,13 +1,20 @@
 import { type Locale } from '../../i18n';
-import type { Encoding, MeasureTree } from '../../properties';
+import type { MeasureTree } from '../../properties';
 import { type BackgroundColor, type Color, type Dataset, type Dimensions, type Label, type Legend, type Theme, type Tooltip } from '../../properties';
 /**
- * 堆叠玫瑰图类型定义
  * @description 堆叠玫瑰图，适用于多维度数据对比场景，通过极坐标系下的扇形弧度和半径展示数据大小
  * 适用场景:
  * - 多维度数据的分布对比
  * - 周期性数据的强弱比较
  * - 分类数据的数值与占比同时展示
+ * @encoding
+ * 堆叠玫瑰图支持以下视觉通道:
+ * `angle`  : 角度通道, 支持`多个维度`, 按维度值映射至角度轴
+ * `radius` : 半径通道, 支持`多个指标`, 按指标值映射至半径轴
+ * `detail` : 细分通道, 支持`多个维度`, 在同一个颜色系列下展示更细粒度的数据时使用
+ * `color`  : 颜色通道, 支持`多个维度`或 `一个指标`, 维度颜色用于区分不同的数据系列, 指标颜色用于线性映射指标值到图形颜色
+ * `tooltip`: 提示通道, 支持`多个维度`与 `多个指标`, 会在鼠标悬停在数据点上时展示
+ * `label`  : 标签通道, 支持`多个维度`与 `多个指标`, 会在数据点上展示数据标签
  * @warning
  * 数据要求:
  * - 至少1个数值字段（度量）
@@ -34,18 +41,6 @@ export interface Rose {
      * @example [{month:'1月', value:100}, {month:'2月', value:150}, {month:'3月', value:120}]
      */
     dataset: Dataset;
-    /**
-     * @description 编码配置, 堆叠玫瑰图的视觉通道, 包括: angle通道, color通道, detail通道, label通道, tooltip通道
-     * - angle: 映射到角度的字段, 支持放入多个维度
-     * - detail: 细分映射通道, 支持放入多个维度
-     * - tooltip: 提示映射通道, 支持放入多个维度 和 多个指标
-     * - color: 颜色映射通道, 支持放入多个维度 或 1个 指标
-     * - label: 标签映射通道, 支持放入 多个维度 或 多个指标
-     *
-     * @tip 特殊的:
-     * - radius: measures会直接映射到半径通道
-     */
-    encoding?: Pick<Encoding, 'angle' | 'color' | 'detail' | 'label' | 'tooltip'>;
     /**
      * 维度
      * @description 玫瑰图的第一个维度被映射到角度轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示.