@visactor/vseed 0.1.6 → 0.1.8

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

@@ -19,11 +19,6 @@ export declare const zRose: 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/roseParallel/roseParallel.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 RoseParallel {
      * @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/roseParallel/zRoseParallel.d.ts

@@ -19,11 +19,6 @@ export declare const zRoseParallel: 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/scatter/scatter.d.ts

@@ -1,10 +1,16 @@
 import type { Locale } from '../../i18n';
-import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, Color, Dataset, Dimensions, Label, Legend, PointStyle, Theme, Tooltip, CrosshairLine, YLinearAxis, XLinearAxis, MeasureTree, Encoding, ScatterMeasures } from '../../properties';
+import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, Color, Dataset, Dimensions, Label, Legend, PointStyle, Theme, Tooltip, CrosshairLine, YLinearAxis, XLinearAxis, MeasureTree, ScatterMeasures } from '../../properties';
 /**
- * 散点图类型定义
  * @description 散点图，适用于展示数据的分布情况，通过点的位置表示数据的数值
  * 适用场景:
  * - 分析数据的分布特征, 如数据的中心趋势, 分布范围, 异常值等
+ * @encoding
+ * 散点图支持以下视觉通道:
+ * `xAxis`  : x轴通道, 支持`多个指标`, 按指标值映射至x轴
+ * `yAxis`  : y轴通道, 支持`多个指标`, 按指标值映射至y轴
+ * `color`  : 颜色通道, 支持`多个维度`或 `一个指标`, 维度颜色用于区分不同的数据系列, 指标颜色用于线性映射指标值到图形颜色
+ * `tooltip`: 提示通道, 支持`多个维度`与 `多个指标`, 会在鼠标悬停在数据点上时展示
+ * `label`  : 标签通道, 支持`多个维度`与 `多个指标`, 会在数据点上展示数据标签
  * @warning
  * 数据要求:
  * - 至少2个数值字段（度量）
@@ -31,18 +37,6 @@ export interface Scatter {
      * @example [{month:'1月', value:100}, {month:'2月', value:150}, {month:'3月', value:120}]
      */
     dataset: Dataset;
-    /**
-     * @description 编码配置, 散点图的视觉通道, 包括:  color通道, detail通道, label通道, tooltip通道
-     * - detail: 细分映射通道, 支持放入多个维度
-     * - tooltip: 提示映射通道, 支持放入多个维度 和 多个指标
-     * - color: 颜色映射通道, 支持放入多个维度 或 1个 指标
-     * - label: 标签映射通道, 支持放入 多个维度 或 多个指标
-     *
-     * @tip 特殊的:
-     * - x: measures会直接映射到X轴通道
-     * - y: measures会直接映射到Y轴通道
-     */
-    encoding?: Pick<Encoding, 'color' | 'detail' | 'label' | 'tooltip'>;
     /**
      * 维度
      * @description 散点图的第一个维度被映射到X轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示

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

@@ -19,11 +19,6 @@ export declare const zScatter: 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/table/table.d.ts

@@ -7,6 +7,8 @@ import { type BackgroundColor, type Dataset, type Theme } from '../../properties
  * - 需要展示详细数据明细
  * - 数据项需要精确比对
  * - 展示多维度数据属性
+ * @encoding
+ * 仅支持配置维度树与指标树, 默认encoding到column
  * @warning
  * 数据要求:
  * - 至少1个维度字段

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

@@ -5,11 +5,6 @@ export declare const zTable: 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/properties/dimensions/dimensions.d.ts

@@ -4,10 +4,6 @@
 export type Dimension = {
     id: string;
     alias?: string;
-    /**
-     * @deprecated 请使用 encoding 代替
-     */
-    location?: 'dimension' | 'rowDimension' | 'columnDimension';
     /**
      * @description 维度映射的通道
      * - x: 支持将多个维度映射到x轴, 支持柱状图、折线图、面积图等

package/dist/types/properties/dimensions/zDimensions.d.ts

@@ -3,11 +3,6 @@ import type { DimensionGroup } from './dimensions';
 export declare const zDimension: 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";
@@ -24,11 +19,6 @@ export declare const zDimensionGroup: z.ZodType<DimensionGroup>;
 export declare const zDimensions: 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";
@@ -44,11 +34,6 @@ export declare const zDimensions: z.ZodArray<z.ZodObject<{
 export declare const zDimensionTree: z.ZodArray<z.ZodUnion<[z.ZodType<DimensionGroup, unknown, z.core.$ZodTypeInternals<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";

package/dist/types/zVseed.d.ts

@@ -5,11 +5,6 @@ export declare const zVSeed: z.ZodDiscriminatedUnion<[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";
@@ -97,11 +92,6 @@ export declare const zVSeed: z.ZodDiscriminatedUnion<[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";
@@ -203,11 +193,6 @@ export declare const zVSeed: z.ZodDiscriminatedUnion<[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";
@@ -1599,11 +1584,6 @@ export declare const zVSeed: z.ZodDiscriminatedUnion<[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";
@@ -2811,11 +2791,6 @@ export declare const zVSeed: z.ZodDiscriminatedUnion<[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";
@@ -4023,11 +3998,6 @@ export declare const zVSeed: z.ZodDiscriminatedUnion<[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";
@@ -5235,11 +5205,6 @@ export declare const zVSeed: z.ZodDiscriminatedUnion<[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";
@@ -6447,11 +6412,6 @@ export declare const zVSeed: z.ZodDiscriminatedUnion<[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";
@@ -7659,11 +7619,6 @@ export declare const zVSeed: z.ZodDiscriminatedUnion<[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";
@@ -8871,11 +8826,6 @@ export declare const zVSeed: z.ZodDiscriminatedUnion<[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";
@@ -10398,11 +10348,6 @@ export declare const zVSeed: z.ZodDiscriminatedUnion<[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";
@@ -11925,11 +11870,6 @@ export declare const zVSeed: z.ZodDiscriminatedUnion<[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";
@@ -13332,11 +13272,6 @@ export declare const zVSeed: z.ZodDiscriminatedUnion<[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";
@@ -15381,11 +15316,6 @@ export declare const zVSeed: z.ZodDiscriminatedUnion<[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";
@@ -15539,11 +15469,6 @@ export declare const zVSeed: z.ZodDiscriminatedUnion<[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";
@@ -15697,11 +15622,6 @@ export declare const zVSeed: z.ZodDiscriminatedUnion<[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";
@@ -15855,11 +15775,6 @@ export declare const zVSeed: z.ZodDiscriminatedUnion<[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";
@@ -16013,11 +15928,6 @@ export declare const zVSeed: z.ZodDiscriminatedUnion<[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";
@@ -16171,11 +16081,6 @@ export declare const zVSeed: z.ZodDiscriminatedUnion<[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";
@@ -16286,11 +16191,6 @@ export declare const zVSeed: z.ZodDiscriminatedUnion<[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";