@visactor/vseed 0.1.7 → 0.1.9

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

@@ -0,0 +1,264 @@
+import type { Locale } from '../../i18n';
+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个指标字段（度量）
+ * - 支持指标组, 第一组指标会放置(主轴)左轴, 第二组指标会放置(次轴)右轴
+ * - 第一个维度会放至X轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示.
+ * - 两组指标字段可分别映射到左右两个Y轴, 一个指标组内的所有会自动合并为一个指标
+ * 默认开启的功能:
+ * - 默认开启坐标轴、图例、数据标签、提示信息
+ * @recommend
+ * - 推荐字段配置: `2`个指标, `2`个维度
+ * - 支持数据重塑: 至少`1`个指标, `0`个维度
+ */
+export interface DualAxis {
+    /**
+     * @description 双轴图，展示两个不同量级指标对比关系的复合图表
+     * @example 'dualAxis'
+     */
+    chartType: 'dualAxis';
+    /**
+     * @description 数据集, 符合TidyData规范的且已经聚合的数据集，用于定义图表的数据来源和结构, 用户输入的数据集并不需要进行任何处理, VSeed带有强大的数据重塑功能, 会自行进行数据重塑, 双轴图的数据最终会被转换为2个维度, 1或2个指标(取决于用户是否配置了指标组).
+     * @example [{month:'1月', value:100, growth:0.2}, {month:'2月', value:150, growth:0.5}]
+     */
+    dataset: Dataset;
+    /**
+     * @description 维度, 第一个维度会放至X轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示.
+     * @example [{id: 'month', alias: '月份'}]
+     */
+    dimensions?: Dimensions;
+    /**
+     * @description 双轴图指标
+     * measures可以使用2个指标组, 代表普通双轴图的主轴和次轴指标, 每个指标组内的指标会自动合并为一个指标.
+     * measures可以使用1个指标组, 再嵌套2个指标组, 绘制组合双轴图. 最外层的每一个组, 代表一个双轴图, 它们会纵向排列.
+     * @example
+     * 普通双轴图
+     * [
+     *   {
+     *     id: "primaryAxis",
+     *     alias: '主轴',
+     *     children: [{id: 'profit', alias: '利润'}, {id: 'sales', alias: '销售额'}]
+     *   },
+     *   {
+     *     id: "secondaryAxis",
+     *     alias: '次轴',
+     *     children: [{id: 'growth', alias: '增长率'}, {id: 'returnRatio', alias: '回报率'}]
+     *   }
+     * ]
+     * 组合双轴图
+     * [
+     *   {
+     *     id: "first",
+     *     alias: "第一个双轴图",
+     *     children: [
+     *      {
+     *        id: "primaryAxis",
+     *        alias: '主轴',
+     *        children: [{id: 'profit', alias: '利润'}, {id: 'sales', alias: '销售额'}]
+     *      },
+     *      {
+     *        id: "secondaryAxis",
+     *        alias: '次轴',
+     *        children: [{id: 'growth', alias: '增长率'}, {id: 'returnRatio', alias: '回报率'}]
+     *      },
+     *     ]
+     *   },
+     *   {
+     *     id: "second",
+     *     alias: "第二个双轴图",
+     *     children: [
+     *      {
+     *        id: "primaryAxis2",
+     *        alias: '主轴',
+     *        children: [{id: 'profit2', alias: '利润'}, {id: 'sales2', alias: '销售额'}]
+     *      },
+     *      {
+     *        id: "secondaryAxis2",
+     *        alias: '次轴',
+     *        children: [{id: 'growth2', alias: '增长率'}, {id: 'returnRatio2', alias: '回报率'}]
+     *      },
+     *     ]
+     *   },
+     * ]
+     */
+    measures?: MeasureTree;
+    /**
+     * @description 双轴图指标, 是measures的简化形式
+     * 组合的双轴图指标配置, 每个对象都代表一个双轴图, 双轴图之间纵向排列, 必须是数组.
+     * 每个配置对象内, primaryMeasures代表所有的主轴指标, secondaryMeasures代表所有的次轴指标, primaryMeasures和secondaryMeasures可配置为数组或一个对象
+     * primaryMeasures 如果是多个指标, 则会自动合并
+     * secondaryMeasures 如果是多个指标, 则会自动合并
+     * @example
+     * 如下示例配置了一个双轴图, 主轴有1个value指标, 次轴有1个growth指标
+     * [
+     *   {
+     *     primaryMeasures:   {id: 'value', alias: '数值'}
+     *     secondaryMeasures: {id: 'growth', alias: '增长率'}
+     *   }
+     * ]
+     * 如下示例配置了2个纵向排列的双轴图, 第一个双轴图, 主轴有1个value指标, 次轴有一个growth指标, 第二个双轴图, 主轴有2个指标: profit与sales, 次轴有一个returnRatio指标
+     * [
+     *   {
+     *     primaryMeasures:  {id: 'value', alias: '数值'}
+     *     secondaryMeasures: {id: 'growth', alias: '增长率'}
+     *   },
+     *   {
+     *     primaryMeasures:   [{id: 'profit', alias: '利润'}, {id: 'sales', alias: '销售额'}],
+     *     secondaryMeasures: [{id: 'returnRatio', alias: '回报率'}]
+     *   }
+     * ]
+     */
+    dualMeasures?: DualMeasures;
+    /**
+     * @description 双轴图的主次轴的图表类型, 用于定义双轴图的类型, 包括折线图, 柱状图, 面积图等, 当measures有多组时, dualChartType可以配置为数组, 每项对应一个双轴图的子图表类型.
+     * @example
+     * {primary: 'line', secondary: 'bar'}
+     * [{primary: 'line', secondary: 'bar'}, {primary: 'column', secondary: 'area'}]
+     */
+    dualChartType?: DualChartType | DualChartType[];
+    /**
+     * @description 用于定义双轴图的两根轴的刻度是否对齐, 当measures有多组时, alignTicks可以配置为数组, 每项对应一个双轴图的刻度是否对齐.
+     * @example {"chartType":"dualAxis","dataset":[{"date":"2019","profit":10,"sales":100},{"date":"2020","profit":30,"sales":200},{"date":"2021","profit":30,"sales":300},{"date":"2022","profit":50,"sales":500}],"alignTicks":[false,true],"dualMeasures":[{"primaryMeasures":[{"id":"profit"}],"secondaryMeasures":[{"id":"sales"}]},{"primaryMeasures":[{"id":"profit"}],"secondaryMeasures":[{"id":"sales"}]}]}
+     */
+    alignTicks?: boolean | boolean[];
+    /**
+     * @description 双轴图的主Y轴配置, 用于定义双轴图的主Y轴, 包括主Y轴的位置, 样式等. 当measures有多组时, primaryYAxis可以配置为数组, 每项对应一个双轴图的主Y轴.
+     */
+    primaryYAxis?: YLinearAxis | YLinearAxis[];
+    /**
+     * @description 双轴图的次Y轴配置, 用于定义双轴图的次Y轴, 包括次Y轴的位置, 样式等. 当measures有多组时, secondaryYAxis可以配置为数组, 每项对应一个双轴图的次Y轴.
+     */
+    secondaryYAxis?: YLinearAxis | YLinearAxis[];
+    /**
+     * @default transparent 默认为透明背景
+     * @description 图表的背景颜色, 背景颜色可以是颜色字符串, 例如'red', 'blue', 也可以是hex, rgb或rgba'#ff0000', 'rgba(255,0,0,0.5)'
+     */
+    backgroundColor?: BackgroundColor;
+    /**
+     * @description 颜色配置, 用于定义图表的颜色方案, 包括颜色列表, 颜色映射, 颜色渐变等.
+     */
+    color?: Color;
+    /**
+     * @description 标签配置, 用于定义图表的数据标签, 包括数据标签的位置, 格式, 样式等.
+     */
+    label?: Label;
+    /**
+     * @description 图例配置, 用于定义图表的图例, 包括图例的位置, 格式, 样式等.
+     */
+    legend?: Legend;
+    /**
+     * @description 提示信息配置, 用于定义图表的提示信息, 包括提示信息的位置, 格式, 样式等.
+     */
+    tooltip?: Tooltip;
+    /**
+     * 垂直提示框
+     * @description 垂直提示框配置, 用于定义图表的垂直提示框, 包括垂直提示框的颜色、标签样式等.
+     */
+    crosshairRect?: CrosshairRect;
+    /**
+     * @description X轴排序配置, 支持根据维度或指标排序, 以及自定义排序顺序
+     * @example
+     * sort: {
+     *   orderBy: 'profit',
+     *   order: 'asc',
+     * }
+     * sort: {
+     *   customOrder:['2019', '2020', '2021']
+     * }
+     */
+    sort?: Sort;
+    /**
+     * @description 图例排序配置, 支持根据维度或指标排序, 以及自定义排序顺序
+     * @example
+     * sortLegend: {
+     *   orderBy: 'profit',
+     *   order: 'asc',
+     * }
+     * sortLegend: {
+     *   customOrder:['2019', '2020', '2021']
+     * }
+     */
+    sortLegend?: SortLegend;
+    /**
+     * @description 图表的主题, 主题是优先级较低的功能配置, 包含所有图表类型共用的通用配置, 与单类图表类型共用的图表配置, 内置light与dark两种主题, 用户可以通过Builder自定义主题
+     * @default light 默认为亮色主题
+     * @example 'dark'
+     * @example 'light'
+     * @example 'customThemeName'
+     */
+    theme?: Theme;
+    /**
+     * 矩形图元样式
+     * @description 条形图样式配置, 用于定义图表的条形图样式, 包括条形图的颜色, 边框, 圆角等.
+     * 支持全局样式或条件样式配置
+     * 数据筛选器
+     * 若配置selector, 提供数值 selector, 局部数据 selector, 条件维度 selector, 条件指标 selector 共四类数据匹配能力
+     * 若未配置selector, 则样式全局生效.
+     */
+    barStyle?: BarStyle | BarStyle[];
+    /**
+     * 线图元样式
+     * @description 线图元样式配置, 用于定义图表的线图元样式, 包括线图元的颜色, 透明度, 曲线等.
+     * 支持全局样式或条件样式配置
+     * 数据筛选器
+     * 若配置selector, 提供数值 selector, 局部数据 selector, 条件维度 selector, 条件指标 selector 共四类数据匹配能力
+     * 若未配置selector, 则样式全局生效.
+     */
+    lineStyle?: LineStyle | LineStyle[];
+    /**
+     * 点图元样式
+     * @description 点图元样式配置, 用于定义图表的点图元样式, 包括点图元的颜色, 边框等.
+     * 支持全局样式或条件样式配置
+     * 数据筛选器
+     * 若配置selector, 提供数值 selector, 局部数据 selector, 条件维度 selector, 条件指标 selector 共四类数据匹配能力
+     * 若未配置selector, 则样式全局生效.
+     */
+    pointStyle?: PointStyle | PointStyle[];
+    /**
+     * 面积图元样式
+     * @description 面积图元样式配置, 用于定义图表的面积图元样式, 包括面积图元的颜色, 透明度, 边框等.
+     * 支持全局样式或条件样式配置
+     * 数据筛选器
+     * 若配置selector, 提供数值 selector, 局部数据 selector, 条件维度 selector, 条件指标 selector 共四类数据匹配能力
+     * 若未配置selector, 则样式全局生效.
+     */
+    areaStyle?: AreaStyle | AreaStyle[];
+    /**
+     * @description 标注点配置, 根据选择的数据, 定义图表的标注点, 包括标注点的位置, 格式, 样式等.
+     */
+    annotationPoint?: AnnotationPoint | AnnotationPoint[];
+    /**
+     * @description 标注垂直线配置, 根据选择的数据, 定义图表的标注垂直线, 包括标注垂直线的位置, 样式等.
+     */
+    annotationVerticalLine?: AnnotationVerticalLine | AnnotationVerticalLine[];
+    /**
+     * @description 标注水平线配置, 根据选择的数据, 定义图表的标注水平线, 包括标注水平线的位置, 样式等.
+     */
+    annotationHorizontalLine?: AnnotationHorizontalLine | AnnotationHorizontalLine[];
+    /**
+     * @description 标注区域配置, 根据选择的数据, 定义图表的标注区域, 包括标注区域的位置, 样式等.
+     */
+    annotationArea?: AnnotationArea | AnnotationArea[];
+    /**
+     * @description 国际化配置, 图表语言配置, 支持'zh-CN'与'en-US'两种语言, 另外可以调用 intl.setLocale('zh-CN') 方法设置语言
+     * @default 'zh-CN'
+     */
+    locale?: Locale;
+}

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

@@ -0,0 +1,2 @@
+import { zDualAxis } from "./zDualAxis.js";
+export { zDualAxis };

package/dist/esm/types/chartType/dualAxis/zDualAxis.js

@@ -0,0 +1,36 @@
+import { z } from "zod";
+import { zLocale } from "../../i18n/index.js";
+import { zAnnotationArea, zAnnotationHorizontalLine, zAnnotationPoint, zAnnotationVerticalLine, zAreaStyle, zBackgroundColor, zBarStyle, zColor, zCrosshairRect, zDataset, zDimensions, zDualChartType, zDualMeasures, zLabel, zLegend, zLineStyle, zMeasureTree, zPointStyle, zSort, zSortLegend, zTheme, zTooltip, zXBandAxis, zYLinearAxis } from "../../properties/index.js";
+const zDualAxis = z.object({
+    chartType: z.literal('dualAxis'),
+    dataset: zDataset.nullish(),
+    dimensions: zDimensions.nullish(),
+    measures: zMeasureTree.nullish(),
+    dualMeasures: zDualMeasures.nullish(),
+    dualChartType: z.array(zDualChartType).or(zDualChartType).nullish(),
+    alignTicks: z.array(z.boolean()).or(z.boolean()).nullish(),
+    primaryYAxis: z.array(zYLinearAxis).or(zYLinearAxis).nullish(),
+    secondaryYAxis: z.array(zYLinearAxis).or(zYLinearAxis).nullish(),
+    xAxis: zXBandAxis.nullish(),
+    backgroundColor: zBackgroundColor.nullish(),
+    color: zColor.nullish(),
+    label: zLabel.nullish(),
+    legend: zLegend.nullish(),
+    tooltip: zTooltip.nullish(),
+    crosshairRect: zCrosshairRect.nullish(),
+    sort: zSort.nullish(),
+    sortLegend: zSortLegend.nullish(),
+    theme: zTheme.nullish(),
+    barStyle: z.array(zBarStyle).or(zBarStyle).nullish(),
+    pointStyle: z.array(zPointStyle).or(zPointStyle).nullish(),
+    lineStyle: z.array(zLineStyle).or(zLineStyle).nullish(),
+    areaStyle: z.array(zAreaStyle).or(zAreaStyle).nullish(),
+    annotationPoint: z.array(zAnnotationPoint).or(zAnnotationPoint).nullish(),
+    annotationVerticalLine: z.array(zAnnotationVerticalLine).or(zAnnotationVerticalLine).nullish(),
+    annotationHorizontalLine: z.array(zAnnotationHorizontalLine).or(zAnnotationHorizontalLine).nullish(),
+    annotationArea: z.array(zAnnotationArea).or(zAnnotationArea).nullish(),
+    locale: zLocale.nullish()
+});
+export { zDualAxis };
+
+//# sourceMappingURL=zDualAxis.js.map

package/dist/esm/types/chartType/dualAxis/zDualAxis.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types/chartType/dualAxis/zDualAxis.js","sources":["webpack://@visactor/vseed/./src/types/chartType/dualAxis/zDualAxis.ts"],"sourcesContent":["import { z } from 'zod'\nimport { zLocale } from 'src/types/i18n'\nimport {\n  zAnnotationArea,\n  zAnnotationHorizontalLine,\n  zAnnotationPoint,\n  zAnnotationVerticalLine,\n  zAreaStyle,\n  zBackgroundColor,\n  zBarStyle,\n  zColor,\n  zCrosshairRect,\n  zDataset,\n  zDimensions,\n  zDualChartType,\n  zDualMeasures,\n  zLabel,\n  zLegend,\n  zLineStyle,\n  zMeasureTree,\n  zPointStyle,\n  zSort,\n  zSortLegend,\n  zTheme,\n  zTooltip,\n  zXBandAxis,\n  zYLinearAxis,\n} from 'src/types/properties'\n\nexport const zDualAxis = z.object({\n  chartType: z.literal('dualAxis'),\n\n  dataset: zDataset.nullish(),\n  dimensions: zDimensions.nullish(),\n  measures: zMeasureTree.nullish(),\n  dualMeasures: zDualMeasures.nullish(),\n\n  dualChartType: z.array(zDualChartType).or(zDualChartType).nullish(),\n  alignTicks: z.array(z.boolean()).or(z.boolean()).nullish(),\n  \n  primaryYAxis: z.array(zYLinearAxis).or(zYLinearAxis).nullish(),\n  secondaryYAxis: z.array(zYLinearAxis).or(zYLinearAxis).nullish(),\n  xAxis: zXBandAxis.nullish(),\n\n  backgroundColor: zBackgroundColor.nullish(),\n  color: zColor.nullish(),\n  label: zLabel.nullish(),\n  legend: zLegend.nullish(),\n  tooltip: zTooltip.nullish(),\n\n  crosshairRect: zCrosshairRect.nullish(),\n  sort: zSort.nullish(),\n  sortLegend: zSortLegend.nullish(),\n  theme: zTheme.nullish(),\n\n  barStyle: z.array(zBarStyle).or(zBarStyle).nullish(),\n  pointStyle: z.array(zPointStyle).or(zPointStyle).nullish(),\n  lineStyle: z.array(zLineStyle).or(zLineStyle).nullish(),\n  areaStyle: z.array(zAreaStyle).or(zAreaStyle).nullish(),\n\n  annotationPoint: z.array(zAnnotationPoint).or(zAnnotationPoint).nullish(),\n  annotationVerticalLine: z.array(zAnnotationVerticalLine).or(zAnnotationVerticalLine).nullish(),\n  annotationHorizontalLine: z.array(zAnnotationHorizontalLine).or(zAnnotationHorizontalLine).nullish(),\n  annotationArea: z.array(zAnnotationArea).or(zAnnotationArea).nullish(),\n\n  locale: zLocale.nullish(),\n})\n"],"names":["zDualAxis","z","zDataset","zDimensions","zMeasureTree","zDualMeasures","zDualChartType","zYLinearAxis","zXBandAxis","zBackgroundColor","zColor","zLabel","zLegend","zTooltip","zCrosshairRect","zSort","zSortLegend","zTheme","zBarStyle","zPointStyle","zLineStyle","zAreaStyle","zAnnotationPoint","zAnnotationVerticalLine","zAnnotationHorizontalLine","zAnnotationArea","zLocale"],"mappings":";;;AA6BO,MAAMA,YAAYC,EAAE,MAAM,CAAC;IAChC,WAAWA,EAAE,OAAO,CAAC;IAErB,SAASC,SAAS,OAAO;IACzB,YAAYC,YAAY,OAAO;IAC/B,UAAUC,aAAa,OAAO;IAC9B,cAAcC,cAAc,OAAO;IAEnC,eAAeJ,EAAE,KAAK,CAACK,gBAAgB,EAAE,CAACA,gBAAgB,OAAO;IACjE,YAAYL,EAAE,KAAK,CAACA,EAAE,OAAO,IAAI,EAAE,CAACA,EAAE,OAAO,IAAI,OAAO;IAExD,cAAcA,EAAE,KAAK,CAACM,cAAc,EAAE,CAACA,cAAc,OAAO;IAC5D,gBAAgBN,EAAE,KAAK,CAACM,cAAc,EAAE,CAACA,cAAc,OAAO;IAC9D,OAAOC,WAAW,OAAO;IAEzB,iBAAiBC,iBAAiB,OAAO;IACzC,OAAOC,OAAO,OAAO;IACrB,OAAOC,OAAO,OAAO;IACrB,QAAQC,QAAQ,OAAO;IACvB,SAASC,SAAS,OAAO;IAEzB,eAAeC,eAAe,OAAO;IACrC,MAAMC,MAAM,OAAO;IACnB,YAAYC,YAAY,OAAO;IAC/B,OAAOC,OAAO,OAAO;IAErB,UAAUhB,EAAE,KAAK,CAACiB,WAAW,EAAE,CAACA,WAAW,OAAO;IAClD,YAAYjB,EAAE,KAAK,CAACkB,aAAa,EAAE,CAACA,aAAa,OAAO;IACxD,WAAWlB,EAAE,KAAK,CAACmB,YAAY,EAAE,CAACA,YAAY,OAAO;IACrD,WAAWnB,EAAE,KAAK,CAACoB,YAAY,EAAE,CAACA,YAAY,OAAO;IAErD,iBAAiBpB,EAAE,KAAK,CAACqB,kBAAkB,EAAE,CAACA,kBAAkB,OAAO;IACvE,wBAAwBrB,EAAE,KAAK,CAACsB,yBAAyB,EAAE,CAACA,yBAAyB,OAAO;IAC5F,0BAA0BtB,EAAE,KAAK,CAACuB,2BAA2B,EAAE,CAACA,2BAA2B,OAAO;IAClG,gBAAgBvB,EAAE,KAAK,CAACwB,iBAAiB,EAAE,CAACA,iBAAiB,OAAO;IAEpE,QAAQC,QAAQ,OAAO;AACzB"}

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

@@ -0,0 +1,93 @@
+import type { Locale } from '../../i18n';
+import type { BackgroundColor, ColorLegend, Dataset, Dimensions, Label, LinearColor, MeasureTree, Theme, Tooltip } from '../../properties';
+/**
+ * @description 漏斗图，用于展示单一维度数据的占比关系
+ * 适用场景:
+ * 漏斗图适用场景:
+ * - 适合用来分析具有多个连续、规范化步骤的流程，并清晰地展示在每个环节的数据流失或转化情况
+ * @encoding
+ * 漏斗图支持以下视觉通道:
+ * `size`   : 大小通道, 支持`多个指标`, 按指标值映射至漏斗宽度
+ * `detail` : 细分通道, 支持`多个维度`, 在同一个颜色系列下展示更细粒度的数据时使用
+ * `color`  : 颜色通道, 支持`多个维度`或 `一个指标`, 维度颜色用于区分不同的数据系列, 指标颜色用于线性映射指标值到图形颜色
+ * `tooltip`: 提示通道, 支持`多个维度`与 `多个指标`, 会在鼠标悬停在数据点上时展示
+ * `label`  : 标签通道, 支持`多个维度`与 `多个指标`, 会在数据点上展示数据标签
+ * @warning
+ * 数据要求:
+ * - 至少1个数值字段（指标）
+ * - 所有维度会与指标名称(存在多个指标时)合并成一个维度, 作为图例项展示
+ * - 所有指标会自动合并为一个指标
+ * 默认开启的功能:
+ * - 默认开启图例、数据标签、提示信息、占比计算
+ * @recommend
+ * - 推荐字段配置: `1`个指标, `1`个维度
+ * - 支持数据重塑: 至少`1`个指标, `0`个维度
+ */
+export interface Funnel {
+    /**
+     * 漏斗图
+     * @description 漏斗图，展示单一维度数据的占比关系
+     * @type {'funnel'}
+     * @example 'funnel'
+     */
+    chartType: 'funnel';
+    /**
+     * 数据集
+     * @description 符合TidyData规范的且已经聚合的数据集，用于定义图表的数据来源和结构, 用户输入的数据集并不需要进行任何处理, VSeed带有强大的数据重塑功能, 会自行进行数据重塑, 饼图的数据最终会被转换为1个维度, 1个指标.
+     * @type {Array<Record<string|number, any>>}
+     * @example [{category:'A', value:30}, {category:'B', value:70}]
+     */
+    dataset: Dataset;
+    /**
+     * 维度
+     * @description 漏斗图的所有维度会与指标名称(存在多个指标时)合并成一个维度,并作为图例项展示
+     * @type {Dimensions}
+     * @example [{id: 'category', alias: '类别'}]
+     */
+    dimensions?: Dimensions;
+    /**
+     * 指标
+     * @description 漏斗图的所有指标会自动合并为一个指标, 存在多个指标时, 指标名称会与其余维度合并, 作为图例项展示.
+     * @type {DimensionTree}
+     * @example [{id: 'value', alias: '数值占比', format: 'percent'}]
+     */
+    measures?: MeasureTree;
+    /**
+     * 图表的背景颜色
+     * @default transparent 默认为透明背景
+     * @description 背景颜色可以是颜色字符串, 例如'red', 'blue', 也可以是hex, rgb或rgba'#ff0000', 'rgba(255,0,0,0.5)'
+     */
+    backgroundColor?: BackgroundColor;
+    /**
+     * @description 线性渐变颜色配置, 用于定义图表的颜色方案
+     */
+    color?: LinearColor;
+    /**
+     * @description 标签配置, 用于定义图表的数据标签, 包括数据标签的位置, 格式, 样式等.
+     */
+    label?: Label;
+    /**
+     * @description 颜色图例配置, 用于定义图表的图例, 包括图例的位置, 格式, 样式等.
+     */
+    legend?: ColorLegend;
+    /**
+     * 提示信息
+     * @description 提示信息配置, 用于定义图表的提示信息, 包括提示信息的位置, 格式, 样式等.
+     */
+    tooltip?: Tooltip;
+    /**
+     * 图表的主题, 主题是优先级较低的功能配置, 包含所有图表类型共用的通用配置, 与单类图表类型共用的图表配置
+     * @default light 默认为亮色主题
+     * @description 内置light与dark两种主题, 用户可以通过Builder自定义主题
+     * @example 'dark'
+     * @example 'light'
+     * @example 'customThemeName'
+     */
+    theme?: Theme;
+    /**
+     * 语言
+     * @description 图表语言配置, 支持'zh-CN'与'en-US'两种语言, 另外可以调用 intl.setLocale('zh-CN') 方法设置语言
+     * @default 'zh-CN'
+     */
+    locale?: Locale;
+}

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

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

package/dist/esm/types/chartType/funnel/zFunnel.js

@@ -0,0 +1,20 @@
+import { z } from "zod";
+import { zLocale } from "../../i18n/index.js";
+import { zBackgroundColor, zColor, zColorLegend, zDataset, zDimensions, zEncoding, zLabel, zMeasureTree, zTheme, zTooltip } from "../../properties/index.js";
+const zFunnel = z.object({
+    chartType: z.literal('funnel'),
+    dataset: zDataset.nullish(),
+    encoding: zEncoding.nullish(),
+    dimensions: zDimensions.nullish(),
+    measures: zMeasureTree.nullish(),
+    backgroundColor: zBackgroundColor.nullish(),
+    color: zColor.nullish(),
+    label: zLabel.nullish(),
+    legend: zColorLegend.nullish(),
+    tooltip: zTooltip.nullish(),
+    theme: zTheme.nullish(),
+    locale: zLocale.nullish()
+});
+export { zFunnel };
+
+//# sourceMappingURL=zFunnel.js.map

package/dist/esm/types/chartType/funnel/zFunnel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types/chartType/funnel/zFunnel.js","sources":["webpack://@visactor/vseed/./src/types/chartType/funnel/zFunnel.ts"],"sourcesContent":["import { z } from 'zod'\nimport { zLocale } from '../../i18n'\nimport {\n  zBackgroundColor,\n  zColor,\n  zColorLegend,\n  zDataset,\n  zDimensions,\n  zEncoding,\n  zLabel,\n  zMeasureTree,\n  zTheme,\n  zTooltip,\n} from '../../properties'\n\nexport const zFunnel = z.object({\n  chartType: z.literal('funnel'),\n  dataset: zDataset.nullish(),\n  encoding: zEncoding.nullish(),\n  dimensions: zDimensions.nullish(),\n  measures: zMeasureTree.nullish(),\n  backgroundColor: zBackgroundColor.nullish(),\n  color: zColor.nullish(),\n  label: zLabel.nullish(),\n  legend: zColorLegend.nullish(),\n  tooltip: zTooltip.nullish(),\n  theme: zTheme.nullish(),\n  locale: zLocale.nullish(),\n})\n"],"names":["zFunnel","z","zDataset","zEncoding","zDimensions","zMeasureTree","zBackgroundColor","zColor","zLabel","zColorLegend","zTooltip","zTheme","zLocale"],"mappings":";;;AAeO,MAAMA,UAAUC,EAAE,MAAM,CAAC;IAC9B,WAAWA,EAAE,OAAO,CAAC;IACrB,SAASC,SAAS,OAAO;IACzB,UAAUC,UAAU,OAAO;IAC3B,YAAYC,YAAY,OAAO;IAC/B,UAAUC,aAAa,OAAO;IAC9B,iBAAiBC,iBAAiB,OAAO;IACzC,OAAOC,OAAO,OAAO;IACrB,OAAOC,OAAO,OAAO;IACrB,QAAQC,aAAa,OAAO;IAC5B,SAASC,SAAS,OAAO;IACzB,OAAOC,OAAO,OAAO;IACrB,QAAQC,QAAQ,OAAO;AACzB"}

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

@@ -0,0 +1,98 @@
+import { type Locale } from '../../i18n';
+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个维度字段，用于确定热力图的行和列
+ * - 至少1个数值字段（度量），用于映射颜色深浅
+ * - 支持多个指标时，通常选择一个指标进行颜色映射
+ * 默认开启的功能:
+ * - 默认开启图例、坐标轴、数据标签、提示信息、数值缩放
+ * @recommend
+ * - 推荐字段配置: `1`个指标, `2`个维度
+ * - 支持数据重塑: 至少`1`个指标, `0`个维度
+ */
+export interface Heatmap {
+    /**
+     * 热力图
+     * @description 热力图，通过二维矩阵的颜色深浅展示数据的分布和强弱关系
+     * @type {'heatmap'}
+     * @example 'heatmap'
+     */
+    chartType: 'heatmap';
+    /**
+     * 数据集
+     * @description 符合TidyData规范的且已经聚合的数据集，用于定义图表的数据来源和结构, 用户输入的数据集并不需要进行任何处理, VSeed带有强大的数据重塑功能, 会自行进行数据重塑, 热力图的数据最终会被转换为2个维度, 1个指标.
+     * @type {Array<Record<string|number, any>>}
+     * @example [{month:'1月', value:100}, {month:'2月', value:150}, {month:'3月', value:120}]
+     */
+    dataset: Dataset;
+    /**
+     * 维度
+     * @description 热力图的第一个维度被映射到角度轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示.
+     * @type {Dimensions}
+     * @example [{id: 'category', alias: '类别'}]
+     */
+    dimensions?: Dimensions;
+    /**
+     * 指标
+     * @description 热力图的指标会自动合并为一个指标, 映射到半径轴, 存在多个指标时, 指标名称会与其余维度合并, 作为图例项展示.
+     * @type {MeasureTree}
+     * @example [{id: 'value', alias: '数值'}]
+     */
+    measures?: MeasureTree;
+    /**
+     * 图表的背景颜色
+     * @default transparent 默认为透明背景
+     * @description 背景颜色可以是颜色字符串, 例如'red', 'blue', 也可以是hex, rgb或rgba'#ff0000', 'rgba(255,0,0,0.5)'
+     */
+    backgroundColor?: BackgroundColor;
+    /**
+     * 颜色
+     * @description 颜色配置, 用于定义图表的颜色方案, 包括颜色列表, 颜色映射, 颜色渐变等.
+     */
+    color?: LinearColor;
+    /**
+     * @description 热力图标签配置, 用于定义图表的数据标签, 自动开启标签反色, 确保标签可读性.
+     */
+    label?: Label;
+    /**
+     * 图例
+     * @description 热力图的颜色图例配置, 用于定义图表的图例, 包括图例的位置, 格式, 样式等.
+     */
+    legend?: ColorLegend;
+    /**
+     * 提示信息
+     * @description 热力图的提示信息配置, 用于定义图表的提示信息, 包括提示信息的位置, 格式, 样式等.
+     */
+    tooltip?: Tooltip;
+    /**
+     * 图表的主题, 主题是优先级较低的功能配置, 包含所有图表类型共用的通用配置, 与单类图表类型共用的图表配置
+     * @default light 默认为亮色主题
+     * @description 内置light与dark两种主题, 用户可以通过Builder自定义主题
+     * @example 'dark'
+     * @example 'light'
+     * @example 'customThemeName'
+     */
+    theme?: Theme;
+    /**
+     * 语言
+     * @description 图表语言配置, 支持'zh-CN'与'en-US'两种语言, 另外可以调用 intl.setLocale('zh-CN') 方法设置语言
+     * @default 'zh-CN'
+     */
+    locale?: Locale;
+}

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

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

package/dist/esm/types/chartType/heatmap/zHeatmap.js

@@ -0,0 +1,19 @@
+import { z } from "zod";
+import { zLocale } from "../../i18n/index.js";
+import { zBackgroundColor, zColor, zColorLegend, zDataset, zDimensions, zLabel, zMeasureTree, zTheme, zTooltip } from "../../properties/index.js";
+const zHeatmap = z.object({
+    chartType: z.literal('heatmap'),
+    dataset: zDataset.nullish(),
+    dimensions: zDimensions.nullish(),
+    measures: zMeasureTree.nullish(),
+    backgroundColor: zBackgroundColor.nullish(),
+    color: zColor.nullish(),
+    label: zLabel.nullish(),
+    legend: zColorLegend.nullish(),
+    tooltip: zTooltip.nullish(),
+    theme: zTheme.nullish(),
+    locale: zLocale.nullish()
+});
+export { zHeatmap };
+
+//# sourceMappingURL=zHeatmap.js.map

package/dist/esm/types/chartType/heatmap/zHeatmap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types/chartType/heatmap/zHeatmap.js","sources":["webpack://@visactor/vseed/./src/types/chartType/heatmap/zHeatmap.ts"],"sourcesContent":["import { z } from 'zod'\nimport { zLocale } from '../../i18n'\n\nimport {\n  zBackgroundColor,\n  zColor,\n  zColorLegend,\n  zDataset,\n  zDimensions,\n  zLabel,\n  zMeasureTree,\n  zTheme,\n  zTooltip,\n} from '../../properties'\n\nexport const zHeatmap = z.object({\n  chartType: z.literal('heatmap'),\n  dataset: zDataset.nullish(),\n  dimensions: zDimensions.nullish(),\n  measures: zMeasureTree.nullish(),\n  backgroundColor: zBackgroundColor.nullish(),\n  color: zColor.nullish(),\n  label: zLabel.nullish(),\n  legend: zColorLegend.nullish(),\n  tooltip: zTooltip.nullish(),\n  theme: zTheme.nullish(),\n  locale: zLocale.nullish(),\n})\n"],"names":["zHeatmap","z","zDataset","zDimensions","zMeasureTree","zBackgroundColor","zColor","zLabel","zColorLegend","zTooltip","zTheme","zLocale"],"mappings":";;;AAeO,MAAMA,WAAWC,EAAE,MAAM,CAAC;IAC/B,WAAWA,EAAE,OAAO,CAAC;IACrB,SAASC,SAAS,OAAO;IACzB,YAAYC,YAAY,OAAO;IAC/B,UAAUC,aAAa,OAAO;IAC9B,iBAAiBC,iBAAiB,OAAO;IACzC,OAAOC,OAAO,OAAO;IACrB,OAAOC,OAAO,OAAO;IACrB,QAAQC,aAAa,OAAO;IAC5B,SAASC,SAAS,OAAO;IACzB,OAAOC,OAAO,OAAO;IACrB,QAAQC,QAAQ,OAAO;AACzB"}

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

@@ -0,0 +1,20 @@
+export * from "./table/index.js";
+export * from "./pivotTable/index.js";
+export * from "./line/index.js";
+export * from "./column/index.js";
+export * from "./columnParallel/index.js";
+export * from "./columnPercent/index.js";
+export * from "./bar/index.js";
+export * from "./barParallel/index.js";
+export * from "./barPercent/index.js";
+export * from "./area/index.js";
+export * from "./areaPercent/index.js";
+export * from "./scatter/index.js";
+export * from "./dualAxis/index.js";
+export * from "./rose/index.js";
+export * from "./roseParallel/index.js";
+export * from "./pie/index.js";
+export * from "./donut/index.js";
+export * from "./radar/index.js";
+export * from "./funnel/index.js";
+export * from "./heatmap/index.js";

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

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