@visactor/vseed 0.1.7 → 0.1.8

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

@@ -1,5 +1,5 @@
 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 堆叠玫瑰图，适用于多维度数据对比场景，通过极坐标系下的扇形弧度和半径展示数据大小
@@ -8,22 +8,13 @@ import { type BackgroundColor, type Color, type Dataset, type Dimensions, type L
  * - 周期性数据的强弱比较
  * - 分类数据的数值与占比同时展示
  * @encoding
- * 维度未包含任何`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
+ * 堆叠玫瑰图支持以下视觉通道:
+ * `angle`  : 角度通道, 支持`多个维度`, 按维度值映射至角度轴
+ * `radius` : 半径通道, 支持`多个指标`, 按指标值映射至半径轴
+ * `detail` : 细分通道, 支持`多个维度`, 在同一个颜色系列下展示更细粒度的数据时使用
+ * `color`  : 颜色通道, 支持`多个维度`或 `一个指标`, 维度颜色用于区分不同的数据系列, 指标颜色用于线性映射指标值到图形颜色
+ * `tooltip`: 提示通道, 支持`多个维度`与 `多个指标`, 会在鼠标悬停在数据点上时展示
+ * `label`  : 标签通道, 支持`多个维度`与 `多个指标`, 会在数据点上展示数据标签
  * @warning
  * 数据要求:
  * - 至少1个数值字段（度量）
@@ -50,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 玫瑰图的第一个维度被映射到角度轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示.

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

@@ -1,5 +1,5 @@
 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 分组玫瑰图，适用于多维度数据对比场景，通过极坐标系下的扇形弧度和半径展示数据大小
@@ -8,22 +8,13 @@ import { type BackgroundColor, type Color, type Dataset, type Dimensions, type L
  * - 周期性数据的强弱比较
  * - 分类数据的数值与占比同时展示
  * @encoding
- * 维度未包含任何`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
+ * 分组玫瑰图支持以下视觉通道:
+ * `angle`  : 角度通道, 支持`多个维度`, 按维度值映射至角度轴
+ * `radius` : 半径通道, 支持`多个指标`, 按指标值映射至半径轴
+ * `detail` : 细分通道, 支持`多个维度`, 在同一个颜色系列下展示更细粒度的数据时使用
+ * `color`  : 颜色通道, 支持`多个维度`或 `一个指标`, 维度颜色用于区分不同的数据系列, 指标颜色用于线性映射指标值到图形颜色
+ * `tooltip`: 提示通道, 支持`多个维度`与 `多个指标`, 会在鼠标悬停在数据点上时展示
+ * `label`  : 标签通道, 支持`多个维度`与 `多个指标`, 会在数据点上展示数据标签
  * @warning
  * 数据要求:
  * - 至少1个数值字段（度量）
@@ -50,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/scatter/scatter.d.ts

@@ -1,25 +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
- * 维度未包含任何`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
+ * 散点图支持以下视觉通道:
+ * `xAxis`  : x轴通道, 支持`多个指标`, 按指标值映射至x轴
+ * `yAxis`  : y轴通道, 支持`多个指标`, 按指标值映射至y轴
+ * `color`  : 颜色通道, 支持`多个维度`或 `一个指标`, 维度颜色用于区分不同的数据系列, 指标颜色用于线性映射指标值到图形颜色
+ * `tooltip`: 提示通道, 支持`多个维度`与 `多个指标`, 会在鼠标悬停在数据点上时展示
+ * `label`  : 标签通道, 支持`多个维度`与 `多个指标`, 会在数据点上展示数据标签
  * @warning
  * 数据要求:
  * - 至少2个数值字段（度量）
@@ -46,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轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示