@visactor/vseed 0.5.4 → 0.5.6

package/dist/esm/types/chartType/index.js

@@ -24,6 +24,8 @@ export * from "./radar/index.js";
 export * from "./treeMap/index.js";
 export * from "./sunburst/index.js";
 export * from "./circlePacking/index.js";
+export * from "./hierarchySankey/index.js";
+export * from "./sankey/index.js";
 export * from "./racePie/index.js";
 export * from "./raceDonut/index.js";
 export * from "./funnel/index.js";

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

@@ -16,6 +16,8 @@ export declare const zLine: z.ZodObject<{
         column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         player: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         hierarchy: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        source: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        target: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         value: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q1: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q3: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
@@ -41,6 +43,8 @@ export declare const zLine: z.ZodObject<{
             row: "row";
             player: "player";
             hierarchy: "hierarchy";
+            source: "source";
+            target: "target";
         }>>;
         timeFormat: z.ZodOptional<z.ZodOptional<z.ZodObject<{
             type: z.ZodEnum<{

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

@@ -16,6 +16,8 @@ export declare const zPie: z.ZodObject<{
         column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         player: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         hierarchy: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        source: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        target: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         value: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q1: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q3: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
@@ -41,6 +43,8 @@ export declare const zPie: z.ZodObject<{
             row: "row";
             player: "player";
             hierarchy: "hierarchy";
+            source: "source";
+            target: "target";
         }>>;
         timeFormat: z.ZodOptional<z.ZodOptional<z.ZodObject<{
             type: z.ZodEnum<{

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

@@ -17,6 +17,8 @@ export declare const zPivotTable: z.ZodObject<{
             row: "row";
             player: "player";
             hierarchy: "hierarchy";
+            source: "source";
+            target: "target";
         }>>;
         timeFormat: z.ZodOptional<z.ZodOptional<z.ZodObject<{
             type: z.ZodEnum<{

package/dist/esm/types/chartType/raceBar/zRaceBar.d.ts

@@ -16,6 +16,8 @@ export declare const zRaceBar: z.ZodObject<{
         column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         player: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         hierarchy: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        source: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        target: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         value: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q1: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q3: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
@@ -41,6 +43,8 @@ export declare const zRaceBar: z.ZodObject<{
             row: "row";
             player: "player";
             hierarchy: "hierarchy";
+            source: "source";
+            target: "target";
         }>>;
         timeFormat: z.ZodOptional<z.ZodOptional<z.ZodObject<{
             type: z.ZodEnum<{

package/dist/esm/types/chartType/raceColumn/zRaceColumn.d.ts

@@ -16,6 +16,8 @@ export declare const zRaceColumn: z.ZodObject<{
         column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         player: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         hierarchy: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        source: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        target: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         value: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q1: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q3: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
@@ -41,6 +43,8 @@ export declare const zRaceColumn: z.ZodObject<{
             row: "row";
             player: "player";
             hierarchy: "hierarchy";
+            source: "source";
+            target: "target";
         }>>;
         timeFormat: z.ZodOptional<z.ZodOptional<z.ZodObject<{
             type: z.ZodEnum<{

package/dist/esm/types/chartType/raceDonut/zRaceDonut.d.ts

@@ -16,6 +16,8 @@ export declare const zRaceDonut: z.ZodObject<{
         column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         player: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         hierarchy: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        source: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        target: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         value: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q1: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q3: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
@@ -41,6 +43,8 @@ export declare const zRaceDonut: z.ZodObject<{
             row: "row";
             player: "player";
             hierarchy: "hierarchy";
+            source: "source";
+            target: "target";
         }>>;
         timeFormat: z.ZodOptional<z.ZodOptional<z.ZodObject<{
             type: z.ZodEnum<{

package/dist/esm/types/chartType/raceLine/zRaceLine.d.ts

@@ -16,6 +16,8 @@ export declare const zRaceLine: z.ZodObject<{
         column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         player: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         hierarchy: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        source: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        target: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         value: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q1: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q3: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
@@ -41,6 +43,8 @@ export declare const zRaceLine: z.ZodObject<{
             row: "row";
             player: "player";
             hierarchy: "hierarchy";
+            source: "source";
+            target: "target";
         }>>;
         timeFormat: z.ZodOptional<z.ZodOptional<z.ZodObject<{
             type: z.ZodEnum<{

package/dist/esm/types/chartType/racePie/zRacePie.d.ts

@@ -16,6 +16,8 @@ export declare const zRacePie: z.ZodObject<{
         column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         player: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         hierarchy: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        source: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        target: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         value: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q1: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q3: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
@@ -41,6 +43,8 @@ export declare const zRacePie: z.ZodObject<{
             row: "row";
             player: "player";
             hierarchy: "hierarchy";
+            source: "source";
+            target: "target";
         }>>;
         timeFormat: z.ZodOptional<z.ZodOptional<z.ZodObject<{
             type: z.ZodEnum<{

package/dist/esm/types/chartType/raceScatter/zRaceScatter.d.ts

@@ -16,6 +16,8 @@ export declare const zRaceScatter: z.ZodObject<{
         column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         player: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         hierarchy: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        source: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        target: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         value: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q1: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q3: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
@@ -41,6 +43,8 @@ export declare const zRaceScatter: z.ZodObject<{
             row: "row";
             player: "player";
             hierarchy: "hierarchy";
+            source: "source";
+            target: "target";
         }>>;
         timeFormat: z.ZodOptional<z.ZodOptional<z.ZodObject<{
             type: z.ZodEnum<{

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

@@ -16,6 +16,8 @@ export declare const zRadar: z.ZodObject<{
         column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         player: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         hierarchy: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        source: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        target: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         value: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q1: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q3: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
@@ -41,6 +43,8 @@ export declare const zRadar: z.ZodObject<{
             row: "row";
             player: "player";
             hierarchy: "hierarchy";
+            source: "source";
+            target: "target";
         }>>;
         timeFormat: z.ZodOptional<z.ZodOptional<z.ZodObject<{
             type: z.ZodEnum<{

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

@@ -16,6 +16,8 @@ export declare const zRose: z.ZodObject<{
         column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         player: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         hierarchy: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        source: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        target: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         value: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q1: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q3: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
@@ -41,6 +43,8 @@ export declare const zRose: z.ZodObject<{
             row: "row";
             player: "player";
             hierarchy: "hierarchy";
+            source: "source";
+            target: "target";
         }>>;
         timeFormat: z.ZodOptional<z.ZodOptional<z.ZodObject<{
             type: z.ZodEnum<{

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

@@ -16,6 +16,8 @@ export declare const zRoseParallel: z.ZodObject<{
         column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         player: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         hierarchy: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        source: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        target: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         value: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q1: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         q3: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
@@ -41,6 +43,8 @@ export declare const zRoseParallel: z.ZodObject<{
             row: "row";
             player: "player";
             hierarchy: "hierarchy";
+            source: "source";
+            target: "target";
         }>>;
         timeFormat: z.ZodOptional<z.ZodOptional<z.ZodObject<{
             type: z.ZodEnum<{

package/dist/esm/types/chartType/sankey/index.d.ts

@@ -0,0 +1,2 @@
+export type * from './sankey';
+export * from './zSankey';

package/dist/esm/types/chartType/sankey/index.js

@@ -0,0 +1 @@
+export * from "./zSankey.js";

package/dist/esm/types/chartType/sankey/sankey.d.ts

@@ -0,0 +1,91 @@
+import type { Locale } from '../../i18n';
+import type { BackgroundColor, Color, Dataset, SankeyDimension, SankeyMeasure, Label, Legend, Page, Theme, Tooltip } from '../../properties';
+/**
+ * @description 桑基图，用于展示 source 到 target 的流向关系，通过连线宽度表示流量大小。
+ * 适用场景:
+ * - 展示普通 node-link 结构的流向关系
+ * - 展示多个 source 维度、多 target 维度拼接后的路径流转
+ * @encoding
+ * 桑基图支持以下视觉通道:
+ * `source`: 起点通道, 支持`多个维度`
+ * `target`: 终点通道, 支持`多个维度`
+ * `color`: 颜色通道, 支持`多个维度`
+ * `size`: 大小通道, 支持`一个指标`
+ * `label`: 标签通道, 支持`多个维度`与 `多个指标`
+ * `tooltip`: 提示通道, 支持`多个维度`与 `多个指标`
+ * @warning
+ * 数据要求:
+ * - 至少1个 source 维度或默认维度可映射为 source
+ * - 至少1个 target 维度
+ * - 至少1个数值字段（度量）用于映射流量大小
+ * - advanced pipeline 需要将 tidyData 转换为普通 sankey 可消费的 source / target / value 结构
+ */
+export interface Sankey {
+    /**
+     * 桑基图
+     * @description 桑基图，展示普通 source-target 流向关系和流量大小
+     * @type {'sankey'}
+     * @example 'sankey'
+     */
+    chartType: 'sankey';
+    /**
+     * 数据集
+     * @description 符合 TidyData 规范且已经聚合的数据集，用于定义图表的数据来源和结构
+     * @type {Array<Record<string|number, any>>}
+     * @example [{fromRegion: '华北', toRegion: '华东', value: 30}]
+     */
+    dataset: Dataset;
+    /**
+     * 维度
+     * @description 维度配置，用于定义 source / target 节点结构，支持 source / target / color / detail / label / tooltip / row / column 通道
+     * @example [{id: 'fromRegion', alias: '来源区域'}, {id: 'toRegion', alias: '去向区域', encoding: 'target'}]
+     */
+    dimensions?: SankeyDimension[];
+    /**
+     * 指标
+     * @description 指标配置，用于定义流量大小，支持 size / detail / label / tooltip 通道
+     * @example [{id: 'sales', alias: '销售额'}]
+     */
+    measures?: SankeyMeasure[];
+    /**
+     * 分页配置
+     * @description 用于指定分页的字段名, 必须是维度
+     */
+    page?: Page;
+    /**
+     * 图表的背景颜色
+     * @default transparent 默认为透明背景
+     */
+    backgroundColor?: BackgroundColor;
+    /**
+     * 颜色
+     * @description 颜色配置, 用于定义图表的颜色方案
+     */
+    color?: Color;
+    /**
+     * 标签
+     * @description 标签配置, 用于定义图表的数据标签
+     */
+    label?: Label;
+    /**
+     * 图例
+     * @description 图例配置, 用于定义图形桑基图颜色图例的显示、位置与样式
+     */
+    legend?: Legend;
+    /**
+     * 提示信息
+     * @description 提示信息配置, 用于定义图表的提示信息
+     */
+    tooltip?: Tooltip;
+    /**
+     * 图表的主题
+     * @default light 默认为亮色主题
+     */
+    theme?: Theme;
+    /**
+     * 语言
+     * @description 图表语言配置, 支持 'zh-CN' 与 'en-US'
+     * @default 'zh-CN'
+     */
+    locale?: Locale;
+}