@visactor/vseed 0.1.5 → 0.1.7

package/dist/pipeline/advanced/chart/pipes/{init/autoDimensions.d.ts → default/defaultDimensions.d.ts}

@@ -1,2 +1,2 @@
 import type { AdvancedPipe } from '../../../../../types';
-export declare const autoDimensions: AdvancedPipe;
+export declare const defaultDimensions: AdvancedPipe;

package/dist/pipeline/advanced/{table/pipes/init/autoMeasures.d.ts → chart/pipes/default/defaultMeasureName.d.ts}

@@ -1,2 +1,2 @@
 import type { AdvancedPipe } from '../../../../../types';
-export declare const autoMeasures: AdvancedPipe;
+export declare const defaultMeasureName: AdvancedPipe;

package/dist/pipeline/advanced/chart/pipes/default/defaultMeasures.d.ts

@@ -0,0 +1,5 @@
+import type { AdvancedPipe } from '../../../../../types';
+/**
+ * @description 如果用户没有配置 measures, 则基于 dataset 构建默认的 measures
+ */
+export declare const defaultMeasures: AdvancedPipe;

package/dist/pipeline/advanced/chart/pipes/default/index.d.ts

@@ -0,0 +1,3 @@
+export { defaultMeasures } from './defaultMeasures';
+export { defaultMeasureName } from './defaultMeasureName';
+export { defaultDimensions } from './defaultDimensions';

package/dist/pipeline/advanced/chart/pipes/encoding/bar.d.ts

@@ -1,2 +1,21 @@
 import type { AdvancedPipe } from '../../../../../types';
+/**
+ * @description 条形图、堆叠条形图、并列条形图、百分比条形图
+ * 维度未包含任何`encoding`, 则使用默认映射规则:
+ * 1. y: 第一个维度映射至Y轴
+ * 2. color: 非`Y`轴所有维度与指标名称, 合并映射至颜色通道, 作为图例展示
+ * 3. detail: 非`Y`轴所有维度与指标名称, 映射至Detail通道
+ * 指标未包含任何`encoding`, 则使用默认映射规则:
+ * 1. x: 全部指标映射至`X`轴
+ * 2. tooltip: 全部指标映射至`Tooltip`
+ *
+ * 维度映射规则:
+ * 1. 用户指定的`yAxis`维度映射至Y轴, 支持多个维度; 若未指定, 则默认将第一个维度映射至Y轴
+ * 2. 用户指定的`color`维度映射至颜色通道, 支持多个维度; 若未指定, 则默认将指标名称映射至颜色通道, 作为图例展示
+ * 3. 用户指定的`detail`维度映射至Detail通道, 支持多个维度; 若未指定, 则默认将指标名称映射至Detail通道
+ * 指标映射规则:
+ * 1. 指标未配置`encoding`, 则默认映射至Y轴;
+ * 2. 用户指定的`xAxis`指标映射至`X`轴, 支持多个指标;
+ * 3. 所有指标均映射到`Tooltip`
+ */
 export declare const encodingForBar: AdvancedPipe;

package/dist/pipeline/advanced/chart/pipes/encoding/column.d.ts

@@ -1,2 +1,21 @@
 import type { AdvancedPipe } from '../../../../../types';
+/**
+ * @description 堆叠柱状图、并列柱状图、百分比柱状图
+ * 维度未包含任何`encoding`, 则使用默认映射规则:
+ * 1. x: 第一个维度映射至X轴
+ * 2. color: 非`X`轴所有维度与指标名称, 合并映射至颜色通道, 作为图例展示
+ * 3. detail: 非`X`轴所有维度与指标名称, 映射至Detail通道
+ * 指标未包含任何`encoding`, 则使用默认映射规则:
+ * 1. y: 全部指标映射至Y轴
+ * 2. tooltip: 全部指标映射至Tooltip
+ *
+ * 维度映射规则:
+ * 1. 用户指定的`xAxis`维度映射至X轴, 支持多个维度; 若未指定, 则默认将第一个维度映射至X轴
+ * 2. 用户指定的`color`维度映射至颜色通道, 支持多个维度; 若未指定, 则默认将指标名称映射至颜色通道, 作为图例展示
+ * 3. 用户指定的`detail`维度映射至Detail通道, 支持多个维度; 若未指定, 则默认将指标名称映射至Detail通道
+ * 指标映射规则:
+ * 1. 指标未配置`encoding`, 则默认映射至Y轴;
+ * 2. 用户指定的`yAxis`指标映射至Y轴, 支持多个指标;
+ * 3. 所有指标均映射到Tooltip
+ */
 export declare const encodingForColumn: AdvancedPipe;

package/dist/pipeline/advanced/chart/pipes/encoding/dualAxis.d.ts

@@ -1,2 +1,21 @@
 import type { AdvancedPipe } from '../../../../../types';
+/**
+ * @description 双轴图
+ * 维度未包含任何`encoding`, 则使用默认映射规则:
+ * 1. x: 第一个维度映射至X轴
+ * 2. color: 非`X`轴所有维度与指标名称, 合并映射至颜色通道, 作为图例展示
+ * 3. detail: 非`X`轴所有维度与指标名称, 映射至Detail通道
+ * 指标未包含任何`encoding`, 则使用默认映射规则:
+ * 1. y: 第一个指标映射至主Y轴, 其余指标映射至次Y轴
+ * 2. tooltip: 全部指标映射至Tooltip
+ *
+ * 维度映射规则:
+ * 1. 用户指定的`xAxis`维度映射至X轴, 支持多个维度; 若未指定, 则默认将第一个维度映射至X轴
+ * 2. 用户指定的`color`维度映射至颜色通道, 支持多个维度; 若未指定, 则默认将指标名称映射至颜色通道, 作为图例展示
+ * 3. 用户指定的`detail`维度映射至Detail通道, 支持多个维度; 若未指定, 则默认将指标名称映射至Detail通道
+ * 指标映射规则:
+ * 1. 指标未配置encoding, 则第一个指标默认映射至Y轴, 其余指标默认映射至次Y轴
+ * 2. 用户指定的yAxis指标映射至主Y轴或次Y轴, 支持多个指标;
+ * 3. 所有指标均映射到Tooltip
+ */
 export declare const encodingForDualAxis: AdvancedPipe;

package/dist/pipeline/advanced/chart/pipes/encoding/funnel.d.ts

@@ -1,2 +1,19 @@
 import type { AdvancedPipe } from '../../../../../types';
+/**
+ * @description 漏斗图
+ * 维度未包含任何`encoding`, 则使用默认映射规则:
+ * 1. color: 所有维度与指标名称, 合并映射至颜色通道, 作为图例展示
+ * 2. detail: 所有维度与指标名称, 映射至Detail通道
+ * 指标未包含任何`encoding`, 则使用默认映射规则:
+ * 1. size: 全部指标映射至size通道
+ * 2. tooltip: 全部指标映射至Tooltip
+ *
+ * 维度映射规则:
+ * 1. 用户指定的`color`维度映射至颜色通道, 支持多个维度; 若未指定, 则默认将指标名称映射至颜色通道, 作为图例展示
+ * 2. 用户指定的`detail`维度映射至Detail通道, 支持多个维度; 若未指定, 则默认将指标名称映射至Detail通道
+ * 指标映射规则:
+ * 1. 指标未配置`encoding`, 则默认映射至size通道;
+ * 2. 用户指定的`size`指标映射至size通道, 支持多个指标;
+ * 3. 所有指标均映射到Tooltip
+ */
 export declare const encodingForFunnel: AdvancedPipe;

package/dist/pipeline/advanced/chart/pipes/encoding/heatmap.d.ts

@@ -1,2 +1,21 @@
 import type { AdvancedPipe } from '../../../../../types';
+/**
+ * @description 热力图
+ * 维度未包含任何`encoding`, 则使用默认映射规则:
+ * 1. x: 第一个维度, 合并映射至x轴通道
+ * 2. y: 第二个(若没有第二个则复用第一个)及其之后的维度, 合并映射至y轴通道
+ * 3. color: 所有维度与指标名称, 合并映射至颜色通道, 作为图例展示
+ * 4. detail: 所有维度与指标名称, 映射至Detail通道
+ * 指标未包含任何`encoding`, 则使用默认映射规则:
+ * 1. color: 第一个指标映射至Color通道
+ * 2. tooltip: 全部指标映射至Tooltip
+ *
+ * 维度映射规则:
+ * 1. 用户指定的`color`维度映射至颜色通道, 支持多个维度; 若未指定, 则默认将指标名称映射至颜色通道, 作为图例展示
+ * 2. 用户指定的`detail`维度映射至Detail通道, 支持多个维度; 若未指定, 则默认将指标名称映射至Detail通道
+ * 指标映射规则:
+ * 1. 指标未配置`encoding`, 则默认映射至color通道, 只有一个指标时才会映射至color通道
+ * 2. 用户指定的`detail`指标映射至Detail通道, 支持多个指标;
+ * 3. 所有指标均映射到Tooltip
+ */
 export declare const encodingForHeatmap: AdvancedPipe;

package/dist/pipeline/advanced/chart/pipes/encoding/line.d.ts

@@ -1,2 +1,20 @@
 import type { AdvancedPipe } from '../../../../../types';
+/**
+ * @description 折线图、堆叠面积图、百分比面积图
+ * 维度未包含任何encoding, 则使用默认映射规则:
+ * 1. x: 第一个维度映射至X轴
+ * 2. color: 其余所有维度与指标名称, 合并映射至颜色通道, 作为图例展示
+ * 指标未包含任何encoding, 则使用默认映射规则:
+ * 1. y: 全部指标映射至Y轴
+ * 2. tooltip: 全部指标映射至Tooltip
+ *
+ * 维度映射规则:
+ * 1. 用户指定的xAxis维度映射至X轴, 支持多个维度; 若未指定, 则默认将第一个维度映射至X轴
+ * 2. 用户指定的color维度映射至颜色通道, 支持多个维度; 若未指定, 则默认将指标名称映射至颜色通道, 作为图例展示
+ * 3. 用户指定的`detail`维度映射至Detail通道, 支持多个维度; 若未指定, 则默认将指标名称映射至Detail通道
+ * 指标映射规则:
+ * 1. 指标未配置encoding, 则默认映射至Y轴;
+ * 2. 用户指定的yAxis指标映射至Y轴, 支持多个指标;
+ * 3. 所有指标均映射到Tooltip
+ */
 export declare const encodingForLine: AdvancedPipe;

package/dist/pipeline/advanced/chart/pipes/encoding/pie.d.ts

@@ -1,2 +1,20 @@
 import type { AdvancedPipe } from '../../../../../types';
+/**
+ * @description 饼图、环形图
+ * 维度未包含任何`encoding`, 则使用默认映射规则:
+ * 1. color: 所有维度, 合并映射至颜色通道, 作为图例展示
+ * 2. detail: 所有维度, 映射至Detail通道
+ * 指标未包含任何`encoding`, 则使用默认映射规则:
+ * 1. angle: 全部指标映射至angle轴
+ * 2. tooltip: 全部指标映射至Tooltip
+ *
+ * 维度映射规则:
+ * 1. 用户指定的`color`维度映射至颜色通道, 支持多个维度; 若未指定, 则默认将指标名称映射至颜色通道, 作为图例展示
+ * 2. 用户指定的`detail`维度映射至Detail通道, 支持多个维度; 若未指定, 则默认将指标名称映射至Detail通道
+ * 指标映射规则:
+ * 1. 指标未配置`encoding`, 则默认映射至angle轴;
+ * 2. 用户指定的`angle`指标映射至angle轴, 支持多个指标;
+ * 3. 用户指定的`color`指标映射至color通道, 支持多个指标;
+ * 3. 所有指标均映射到Tooltip
+ */
 export declare const encodingForPie: AdvancedPipe;

package/dist/pipeline/advanced/chart/pipes/encoding/radar.d.ts

@@ -1,2 +1,21 @@
 import type { AdvancedPipe } from '../../../../../types';
+/**
+ * @description 雷达图
+ * 维度未包含任何`encoding`, 则使用默认映射规则:
+ * 1. angle: 第一个维度映射至angle轴
+ * 2. color: 非`Angle`轴所有维度与指标名称, 合并映射至颜色通道, 作为图例展示
+ * 3. detail: 非`Angle`轴所有维度与指标名称, 映射至Detail通道
+ * 指标未包含任何`encoding`, 则使用默认映射规则:
+ * 1. radius: 全部指标映射至radius轴
+ * 2. tooltip: 全部指标映射至Tooltip
+ *
+ * 维度映射规则:
+ * 1. 用户指定的`angle`维度映射至angle轴, 支持多个维度; 若未指定, 则默认将第一个维度映射至angle轴
+ * 2. 用户指定的`color`维度映射至颜色通道, 支持多个维度; 若未指定, 则默认将指标名称映射至颜色通道, 作为图例展示
+ * 3. 用户指定的`detail`维度映射至Detail通道, 支持多个维度; 若未指定, 则默认将指标名称映射至Detail通道
+ * 指标映射规则:
+ * 1. 指标未配置`encoding`, 则默认映射至radius轴;
+ * 2. 用户指定的`radius`指标映射至radius轴, 支持多个指标;
+ * 3. 所有指标均映射到Tooltip
+ */
 export declare const encodingForRadar: AdvancedPipe;

package/dist/pipeline/advanced/chart/pipes/encoding/rose.d.ts

@@ -1,2 +1,21 @@
 import type { AdvancedPipe } from '../../../../../types';
+/**
+ * @description 堆叠玫瑰图、并列玫瑰图
+ * 维度未包含任何`encoding`, 则使用默认映射规则:
+ * 1. angle: 第一个维度映射至angle轴
+ * 2. color: 非`angle`轴所有维度与指标名称, 合并映射至颜色通道, 作为图例展示
+ * 3. detail: 非`angle`轴所有维度与指标名称, 映射至Detail通道
+ * 指标未包含任何`encoding`, 则使用默认映射规则:
+ * 1. radius: 全部指标映射至radius轴
+ * 2. tooltip: 全部指标映射至Tooltip
+ *
+ * 维度映射规则:
+ * 1. 用户指定的`angle`维度映射至angle轴, 支持多个维度; 若未指定, 则默认将第一个维度映射至angle轴
+ * 2. 用户指定的`color`维度映射至颜色通道, 支持多个维度; 若未指定, 则默认将指标名称映射至颜色通道, 作为图例展示
+ * 3. 用户指定的`detail`维度映射至Detail通道, 支持多个维度; 若未指定, 则默认将指标名称映射至Detail通道
+ * 指标映射规则:
+ * 1. 指标未配置`encoding`, 则默认映射至Y轴;
+ * 2. 用户指定的`radius`指标映射至radius轴, 支持多个指标;
+ * 3. 所有指标均映射到Tooltip
+ */
 export declare const encodingForRose: AdvancedPipe;

package/dist/pipeline/advanced/chart/pipes/encoding/scatter.d.ts

@@ -1,2 +1,20 @@
 import type { AdvancedPipe } from '../../../../../types';
+/**
+ * @description 散点图
+ * 维度未包含任何`encoding`, 则使用默认映射规则:
+ * 1. color: 所有维度与指标名称, 合并映射至颜色通道, 作为图例展示
+ * 2. detail: 所有维度与指标名称, 映射至Detail通道
+ * 指标未包含任何`encoding`, 则使用默认映射规则:
+ * 1. x: 第一个指标映射至X轴
+ * 2. y: 第二个及其之后的指标映射至Y轴
+ * 3. tooltip: 全部指标映射至Tooltip
+ *
+ * 维度映射规则:
+ * 2. 用户指定的`color`维度映射至颜色通道, 支持多个维度; 若未指定, 则默认将指标名称映射至颜色通道, 作为图例展示
+ * 3. 用户指定的`detail`维度映射至Detail通道, 支持多个维度; 若未指定, 则默认将指标名称映射至Detail通道
+ * 指标映射规则:
+ * 1. 指标未配置encoding, 则第一个指标默认映射至X轴, 第二个指标默认映射至Y轴
+ * 2. 用户指定的yAxis指标映射至Y轴X轴, 支持多个指标;
+ * 3. 所有指标均映射到Tooltip
+ */
 export declare const encodingForScatter: AdvancedPipe;

package/dist/pipeline/advanced/chart/pipes/index.d.ts

@@ -8,3 +8,4 @@ export * from './markStyle';
 export * from './annotation';
 export * from './analysis';
 export * from './measures';
+export * from './default';

package/dist/pipeline/advanced/chart/pipes/init/index.d.ts

@@ -1,3 +1 @@
 export { initAdvancedVSeed } from './initAdvancedVSeed';
-export { autoDimensions } from './autoDimensions';
-export { getBasicDimensions } from './utils';

package/dist/pipeline/advanced/chart/pipes/measures/utils.d.ts

@@ -1,28 +1,13 @@
-import type { Dataset, Measures, VSeed } from '../../../../../types';
-/**
- * @description 获取指标, 无指标时, 自动生成指标
- * @param vseed vseed
- * @returns 指标
- */
-export declare const getBasicMeasures: (vseed: VSeed) => Measures;
-/**
- * @description 自动根据数据集生成指标
- * @param dataset 数据集
- * @returns
- */
-export declare const generateMeasuresByDataset: (dataset: Dataset) => {
-    id: string;
-    alias: string;
-}[];
+import type { AdvancedVSeed, VSeed } from '../../../../../types';
 /**
  * @description 检查是否为指标树, 指标树深度大于1. 如果存在一个指标为组, 即有children配置, 则认为是指标树.
  * @param vseed vseed
  * @returns
  */
-export declare const isMeasureTreeWithChildren: (vseed: VSeed) => boolean;
+export declare const isMeasureTreeWithChildren: (vseed: VSeed | AdvancedVSeed) => boolean;
 /**
  * @description 检查是否为指标树, 指标树存在parentId. 如果存在一个指标有parentId, 则认为是指标树.
  * @param vseed vseed
  * @returns
  */
-export declare const isMeasureTreeWithParentId: (vseed: VSeed) => boolean;
+export declare const isMeasureTreeWithParentId: (vseed: VSeed | AdvancedVSeed) => boolean;

package/dist/pipeline/advanced/table/pipes/{init/autoPivotMeasures.d.ts → default/defaultDimensions.d.ts}

@@ -1,2 +1,2 @@
 import type { AdvancedPipe } from '../../../../../types';
-export declare const autoPivotMeasures: AdvancedPipe;
+export declare const defaultDimensions: AdvancedPipe;

package/dist/pipeline/advanced/table/pipes/default/defaultMeasureName.d.ts

@@ -0,0 +1,2 @@
+import type { AdvancedPipe } from '../../../../../types';
+export declare const defaultMeasureName: AdvancedPipe;

package/dist/pipeline/advanced/table/pipes/default/defaultMeasures.d.ts

@@ -0,0 +1,5 @@
+import type { AdvancedPipe } from '../../../../../types';
+/**
+ * @description 如果用户没有配置 measures, 则基于 dataset 构建默认的 measures
+ */
+export declare const defaultMeasures: AdvancedPipe;

package/dist/pipeline/advanced/table/pipes/default/index.d.ts

@@ -0,0 +1,3 @@
+export { defaultMeasures } from './defaultMeasures';
+export { defaultMeasureName } from './defaultMeasureName';
+export { defaultDimensions } from './defaultDimensions';

package/dist/pipeline/advanced/table/pipes/encoding/index.d.ts

@@ -0,0 +1 @@
+export { encodingForPivotTable } from './pivotTable';

package/dist/pipeline/advanced/table/pipes/encoding/pivotTable.d.ts

@@ -0,0 +1,2 @@
+import type { AdvancedPipe } from '../../../../../types';
+export declare const encodingForPivotTable: AdvancedPipe;

package/dist/pipeline/advanced/table/pipes/index.d.ts

@@ -1,3 +1,6 @@
 export * from './init';
 export * from './records';
 export * from './config';
+export * from './default';
+export * from './reshape';
+export * from './encoding';

package/dist/pipeline/advanced/table/pipes/init/index.d.ts

@@ -1,5 +1,2 @@
-export * from './autoMeasures';
-export * from './autoDimensions';
 export * from './autoPivotDimensions';
-export * from './autoPivotMeasures';
 export * from './initAdvancedVSeed';

package/dist/pipeline/advanced/table/pipes/reshape/index.d.ts

@@ -0,0 +1 @@
+export { reshapePivotTable } from './reshapePivotTable';

package/dist/pipeline/advanced/table/pipes/{init/autoDimensions.d.ts → reshape/reshapePivotTable.d.ts}

@@ -1,2 +1,2 @@
 import type { AdvancedPipe } from '../../../../../types';
-export declare const autoDimensions: AdvancedPipe;
+export declare const reshapePivotTable: AdvancedPipe;

package/dist/types/advancedVSeed.d.ts

@@ -56,11 +56,6 @@ export declare const zAdvancedVSeed: z.ZodObject<{
     dimensions: z.ZodArray<z.ZodUnion<[z.ZodType<import("./properties").DimensionGroup, unknown, z.core.$ZodTypeInternals<import("./properties").DimensionGroup, unknown>>, 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";
@@ -108,10 +103,12 @@ export declare const zAdvancedVSeed: z.ZodObject<{
             }>>>;
         }, z.core.$strip>>>;
         encoding: z.ZodOptional<z.ZodEnum<{
+            column: "column";
             xAxis: "xAxis";
             yAxis: "yAxis";
             angle: "angle";
             color: "color";
+            detail: "detail";
             tooltip: "tooltip";
             label: "label";
             primaryYAxis: "primaryYAxis";

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

@@ -1,6 +1,25 @@
 import type { Locale } from '../../i18n';
 import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, AreaStyle, BackgroundColor, Color, Dataset, Dimensions, Label, Legend, LineStyle, PointStyle, Theme, Tooltip, XBandAxis, YLinearAxis, CrosshairLine, MeasureTree, Sort, SortLegend, Encoding } from '../../properties';
 /**
+ * @recommend
+ * - 推荐字段配置: `1`个指标, `2`个维度
+ * - 支持数据重塑: 至少`1`个指标, `0`个维度
+ * @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
+ *
  * @description 面积图, 适用于展示数据随时间变化的趋势及累积关系, 通过填充区域增强数据对比. X轴为类目轴(分类数据), Y轴为数值轴(连续数据).
  * 适用场景:
  * - 展示单一数据系列的趋势变化
@@ -14,9 +33,6 @@ import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, Annotat
  * 默认开启的功能:
  * - 模块开启堆叠
  * - 默认开启图例、坐标轴、区域填充、数据标签、提示信息
- * @recommend
- * - 推荐字段配置: `1`个指标, `2`个维度
- * - 支持数据重塑: 至少`1`个指标, `0`个维度
  */
 export interface Area {
     /**

package/dist/types/chartType/area/zArea.d.ts

@@ -19,11 +19,6 @@ export declare const zArea: 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";
@@ -71,10 +66,12 @@ export declare const zArea: z.ZodObject<{
             }>>>;
         }, z.core.$strip>>>;
         encoding: z.ZodOptional<z.ZodEnum<{
+            column: "column";
             xAxis: "xAxis";
             yAxis: "yAxis";
             angle: "angle";
             color: "color";
+            detail: "detail";
             tooltip: "tooltip";
             label: "label";
             primaryYAxis: "primaryYAxis";

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

@@ -1,12 +1,26 @@
 import type { Locale } from '../../i18n';
 import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, AreaStyle, BackgroundColor, Color, Dataset, Dimensions, Label, Legend, LineStyle, PointStyle, Theme, Tooltip, XBandAxis, YLinearAxis, CrosshairLine, MeasureTree, Sort, SortLegend, Encoding } from '../../properties';
 /**
- * 百分比面积图类型定义
  * @description 百分比面积图，适用于展示多类别占比随时间变化的趋势，Y轴以百分比形式展示占比关系
  * 适用场景:
  * - 时间序列的构成变化分析
  * - 多类别占比趋势对比
  * - 累积占比与单一类别占比同时展示
+ * @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
  * 数据要求:
  * - 至少1个指标字段（度量）

package/dist/types/chartType/areaPercent/zAreaPercent.d.ts

@@ -19,11 +19,6 @@ export declare const zAreaPercent: 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";
@@ -71,10 +66,12 @@ export declare const zAreaPercent: z.ZodObject<{
             }>>>;
         }, z.core.$strip>>>;
         encoding: z.ZodOptional<z.ZodEnum<{
+            column: "column";
             xAxis: "xAxis";
             yAxis: "yAxis";
             angle: "angle";
             color: "color";
+            detail: "detail";
             tooltip: "tooltip";
             label: "label";
             primaryYAxis: "primaryYAxis";

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

@@ -2,12 +2,28 @@ import { type Locale } from '../../i18n';
 import type { Encoding, MeasureTree, Sort, SortLegend } from '../../properties';
 import { type AnnotationArea, type AnnotationHorizontalLine, type AnnotationPoint, type AnnotationVerticalLine, type BackgroundColor, type BarStyle, type Color, type CrosshairRect, type Dataset, type Dimensions, type Label, type Legend, type StackCornerRadius, type Theme, type Tooltip, type XLinearAxis, type YBandAxis } from '../../properties';
 /**
- * 条形图类型定义
  * @description 条形图，适用于横向数据对比场景，Y轴为类目轴（分类数据），X轴为数值轴（连续数据），柱子横向排列
  * 适用场景:
  * - 数据项名称较长时
  * - 需要展示数据排名对比
  * - 展示正负双向数据
+ * @encoding
+ * 维度未包含任何`encoding`, 则使用默认映射规则:
+ * 1. y: 第一个维度映射至Y轴
+ * 2. color: 非`Y`轴所有维度与指标名称, 合并映射至颜色通道, 作为图例展示
+ * 3. detail: 非`Y`轴所有维度与指标名称, 映射至Detail通道
+ * 指标未包含任何`encoding`, 则使用默认映射规则:
+ * 1. x: 全部指标映射至`X`轴
+ * 2. tooltip: 全部指标映射至`Tooltip`
+ *
+ * 维度映射规则:
+ * 1. 用户指定的`yAxis`维度映射至Y轴, 支持多个维度; 若未指定, 则默认将第一个维度映射至Y轴
+ * 2. 用户指定的`color`维度映射至颜色通道, 支持多个维度; 若未指定, 则默认将指标名称映射至颜色通道, 作为图例展示
+ * 3. 用户指定的`detail`维度映射至Detail通道, 支持多个维度; 若未指定, 则默认将指标名称映射至Detail通道
+ * 指标映射规则:
+ * 1. 指标未配置`encoding`, 则默认映射至Y轴;
+ * 2. 用户指定的`xAxis`指标映射至`X`轴, 支持多个指标;
+ * 3. 所有指标均映射到`Tooltip`
  * @warning
  * 数据要求:
  * - 至少1个指标（度量）

package/dist/types/chartType/bar/zBar.d.ts

@@ -19,11 +19,6 @@ export declare const zBar: 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";
@@ -71,10 +66,12 @@ export declare const zBar: z.ZodObject<{
             }>>>;
         }, z.core.$strip>>>;
         encoding: z.ZodOptional<z.ZodEnum<{
+            column: "column";
             xAxis: "xAxis";
             yAxis: "yAxis";
             angle: "angle";
             color: "color";
+            detail: "detail";
             tooltip: "tooltip";
             label: "label";
             primaryYAxis: "primaryYAxis";

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

@@ -1,12 +1,28 @@
 import type { Locale } from '../../i18n';
 import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XLinearAxis, YBandAxis, MeasureTree, Sort, SortLegend, Encoding } from '../../properties';
 /**
- * 并列条形图类型定义
  * @description 并列条形图，适用于多指标横向并行对比场景，多个条形平行排列展示不同指标值
  * 适用场景:
  * - 类别名称较长时的多指标对比
  * - 排名与数值同时展示的横向比较
  * - 多维度数据的并列分析
+ * @encoding
+ * 维度未包含任何`encoding`, 则使用默认映射规则:
+ * 1. y: 第一个维度映射至Y轴
+ * 2. color: 非`Y`轴所有维度与指标名称, 合并映射至颜色通道, 作为图例展示
+ * 3. detail: 非`Y`轴所有维度与指标名称, 映射至Detail通道
+ * 指标未包含任何`encoding`, 则使用默认映射规则:
+ * 1. x: 全部指标映射至`X`轴
+ * 2. tooltip: 全部指标映射至`Tooltip`
+ *
+ * 维度映射规则:
+ * 1. 用户指定的`yAxis`维度映射至Y轴, 支持多个维度; 若未指定, 则默认将第一个维度映射至Y轴
+ * 2. 用户指定的`color`维度映射至颜色通道, 支持多个维度; 若未指定, 则默认将指标名称映射至颜色通道, 作为图例展示
+ * 3. 用户指定的`detail`维度映射至Detail通道, 支持多个维度; 若未指定, 则默认将指标名称映射至Detail通道
+ * 指标映射规则:
+ * 1. 指标未配置`encoding`, 则默认映射至Y轴;
+ * 2. 用户指定的`xAxis`指标映射至`X`轴, 支持多个指标;
+ * 3. 所有指标均映射到`Tooltip`
  * @warning
  * 数据要求:
  * - 至少1个指标字段（度量）

package/dist/types/chartType/barParallel/zBarParallel.d.ts

@@ -19,11 +19,6 @@ export declare const zBarParallel: 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";
@@ -71,10 +66,12 @@ export declare const zBarParallel: z.ZodObject<{
             }>>>;
         }, z.core.$strip>>>;
         encoding: z.ZodOptional<z.ZodEnum<{
+            column: "column";
             xAxis: "xAxis";
             yAxis: "yAxis";
             angle: "angle";
             color: "color";
+            detail: "detail";
             tooltip: "tooltip";
             label: "label";
             primaryYAxis: "primaryYAxis";

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

@@ -1,12 +1,28 @@
 import type { Locale } from '../../i18n';
 import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XLinearAxis, YBandAxis, MeasureTree, Sort, SortLegend, Encoding } from '../../properties';
 /**
- * 百分比条形图类型定义
  * @description 百分比条形图，适用于横向展示各类别占比关系的场景，X轴以百分比形式展示数据占比
  * 适用场景:
  * - 类别名称较长时的占比对比
  * - 多维度数据的横向构成分析
  * - 排名与占比同时展示的场景
+ * @encoding
+ * 维度未包含任何`encoding`, 则使用默认映射规则:
+ * 1. y: 第一个维度映射至Y轴
+ * 2. color: 非`Y`轴所有维度与指标名称, 合并映射至颜色通道, 作为图例展示
+ * 3. detail: 非`Y`轴所有维度与指标名称, 映射至Detail通道
+ * 指标未包含任何`encoding`, 则使用默认映射规则:
+ * 1. x: 全部指标映射至`X`轴
+ * 2. tooltip: 全部指标映射至`Tooltip`
+ *
+ * 维度映射规则:
+ * 1. 用户指定的`yAxis`维度映射至Y轴, 支持多个维度; 若未指定, 则默认将第一个维度映射至Y轴
+ * 2. 用户指定的`color`维度映射至颜色通道, 支持多个维度; 若未指定, 则默认将指标名称映射至颜色通道, 作为图例展示
+ * 3. 用户指定的`detail`维度映射至Detail通道, 支持多个维度; 若未指定, 则默认将指标名称映射至Detail通道
+ * 指标映射规则:
+ * 1. 指标未配置`encoding`, 则默认映射至Y轴;
+ * 2. 用户指定的`xAxis`指标映射至`X`轴, 支持多个指标;
+ * 3. 所有指标均映射到`Tooltip`
  * @warning
  * 数据要求:
  * - 至少1个维度字段和1个度量字段