@visactor/vseed 0.0.22 → 0.0.24

package/dist/types/chartType/areaRange/index.d.ts

@@ -0,0 +1 @@
+export * from './areaRange';

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

@@ -0,0 +1,207 @@
+import { z } from 'zod';
+import { type Locale } from '../../i18n';
+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 热力图，通过二维矩阵的颜色深浅展示数据的分布和强弱关系
+ * 适用场景:
+ * - 大规模二维数据的密度和强度展示
+ * - 分类与数值的关联分析
+ * - 时间序列与类别的交叉对比
+ * 数据要求:
+ * - 至少2个维度字段，用于确定热力图的行和列
+ * - 至少1个数值字段（度量），用于映射颜色深浅
+ * - 支持多个指标时，通常选择一个指标进行颜色映射
+ * 默认开启的功能:
+ * - 默认开启图例、坐标轴、数据标签、提示信息、数值缩放
+ */
+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?: Color;
+    /**
+     * 标签
+     * @description 标签配置, 用于定义图表的数据标签, 包括数据标签的位置, 格式, 样式等.
+     */
+    label?: Label;
+    /**
+     * 图例
+     * @description 热力图的颜色图例配置, 用于定义图表的图例, 包括图例的位置, 格式, 样式等.
+     */
+    legend?: Legend;
+    /**
+     * 提示信息
+     * @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;
+}
+export declare const zHeatmap: z.ZodObject<{
+    chartType: z.ZodLiteral<"heatmap">;
+    dataset: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodUnion<[z.ZodString, z.ZodNumber]>, z.ZodAny>>>;
+    dimensions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        alias: z.ZodOptional<z.ZodString>;
+        location: z.ZodDefault<z.ZodEnum<{
+            dimension: "dimension";
+            rowDimension: "rowDimension";
+            columnDimension: "columnDimension";
+        }>>;
+    }, z.core.$strip>>>;
+    measures: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodType<import("../..").MeasureGroup, unknown, z.core.$ZodTypeInternals<import("../..").MeasureGroup, unknown>>, z.ZodObject<{
+        id: z.ZodString;
+        alias: z.ZodOptional<z.ZodString>;
+        autoFormat: z.ZodDefault<z.ZodBoolean>;
+        format: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+            type: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+                number: "number";
+                percent: "percent";
+                permille: "permille";
+                scientific: "scientific";
+            }>>>;
+            ratio: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+            symbol: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+            thousandSeparator: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+            prefix: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+            suffix: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+            fractionDigits: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+            significantDigits: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+            roundingPriority: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+                morePrecision: "morePrecision";
+                lessPrecision: "lessPrecision";
+            }>>>;
+            roundingMode: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+                floor: "floor";
+                ceil: "ceil";
+                expand: "expand";
+                trunc: "trunc";
+                halfCeil: "halfCeil";
+                halfFloor: "halfFloor";
+                halfExpand: "halfExpand";
+                halfTrunc: "halfTrunc";
+                halfEven: "halfEven";
+            }>>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>]>>>;
+    backgroundColor: z.ZodOptional<z.ZodOptional<z.ZodDefault<z.ZodString>>>;
+    color: z.ZodOptional<z.ZodObject<{
+        colorScheme: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        colorMapping: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, z.core.$strip>>;
+    label: z.ZodOptional<z.ZodObject<{
+        enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    }, z.core.$strip>>;
+    legend: z.ZodOptional<z.ZodObject<{
+        enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        border: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        maxSize: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        shapeType: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+            circle: "circle";
+            cross: "cross";
+            diamond: "diamond";
+            square: "square";
+            arrow: "arrow";
+            arrow2Left: "arrow2Left";
+            arrow2Right: "arrow2Right";
+            wedge: "wedge";
+            thinTriangle: "thinTriangle";
+            triangle: "triangle";
+            triangleUp: "triangleUp";
+            triangleDown: "triangleDown";
+            triangleRight: "triangleRight";
+            triangleLeft: "triangleLeft";
+            stroke: "stroke";
+            star: "star";
+            wye: "wye";
+            rect: "rect";
+            arrowLeft: "arrowLeft";
+            arrowRight: "arrowRight";
+            rectRound: "rectRound";
+            roundLine: "roundLine";
+        }>>>;
+        position: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+            left: "left";
+            leftTop: "leftTop";
+            leftBottom: "leftBottom";
+            lt: "lt";
+            lb: "lb";
+            top: "top";
+            topLeft: "topLeft";
+            topRight: "topRight";
+            tl: "tl";
+            tr: "tr";
+            right: "right";
+            rightTop: "rightTop";
+            rightBottom: "rightBottom";
+            rt: "rt";
+            rb: "rb";
+            bottom: "bottom";
+            bottomLeft: "bottomLeft";
+            bottomRight: "bottomRight";
+            bl: "bl";
+            br: "br";
+        }>>>;
+        labelFontSize: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        labelFontColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+        labelFontWeight: z.ZodOptional<z.ZodDefault<z.ZodUnion<[z.ZodNumber, z.ZodString]>>>;
+    }, z.core.$strip>>;
+    tooltip: z.ZodOptional<z.ZodObject<{
+        enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    }, z.core.$strip>>;
+    theme: z.ZodOptional<z.ZodString>;
+    locale: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+        "zh-CN": "zh-CN";
+        "en-US": "en-US";
+    }>>>;
+}, z.core.$strip>;

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

@@ -0,0 +1 @@
+export * from './heatmap';

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

@@ -9,10 +9,13 @@ export * from './barParallel';
 export * from './barPercent';
 export * from './area';
 export * from './areaPercent';
+export * from './areaRange';
+export * from './scatter';
+export type * from './dualAxis';
 export * from './rose';
 export * from './roseParallel';
 export * from './pie';
 export * from './donut';
-export * from './scatter';
+export * from './radar';
 export * from './funnel';
-export type * from './dualAxis';
+export * from './heatmap';

package/dist/types/chartType/radar/index.d.ts

@@ -0,0 +1 @@
+export * from './radar';

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

@@ -0,0 +1,207 @@
+import { z } from 'zod';
+import { type Locale } from '../../i18n';
+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 雷达图，适用于多维度数据的对比分析，通过多轴坐标系展示各维度的数值分布
+ * 适用场景:
+ * - 多维度数据的综合表现对比
+ * - 多个对象在多个指标上的性能评估
+ * - 分类数据的多维度特征展示
+ * 数据要求:
+ * - 至少1个数值字段（度量）
+ * - 第一个维度作为雷达图的各个维度轴，其他维度作为不同的系列进行对比
+ * - 支持多个指标分别作为不同的系列展示
+ * 默认开启的功能:
+ * - 默认开启图例、雷达坐标系、数据标签、提示信息、数值缩放
+ */
+export interface Radar {
+    /**
+     * 雷达图
+     * @description 雷达图，通过多轴坐标系展示多维度数据对比关系
+     * @type {'radar'}
+     * @example 'radar'
+     */
+    chartType: 'radar';
+    /**
+     * 数据集
+     * @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?: Color;
+    /**
+     * 标签
+     * @description 标签配置, 用于定义图表的数据标签, 包括数据标签的位置, 格式, 样式等.
+     */
+    label?: Label;
+    /**
+     * 图例
+     * @description 图例配置, 用于定义图表的图例, 包括图例的位置, 格式, 样式等.
+     */
+    legend?: Legend;
+    /**
+     * 提示信息
+     * @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;
+}
+export declare const zRadar: z.ZodObject<{
+    chartType: z.ZodLiteral<"radar">;
+    dataset: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodUnion<[z.ZodString, z.ZodNumber]>, z.ZodAny>>>;
+    dimensions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        alias: z.ZodOptional<z.ZodString>;
+        location: z.ZodDefault<z.ZodEnum<{
+            dimension: "dimension";
+            rowDimension: "rowDimension";
+            columnDimension: "columnDimension";
+        }>>;
+    }, z.core.$strip>>>;
+    measures: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodType<import("../..").MeasureGroup, unknown, z.core.$ZodTypeInternals<import("../..").MeasureGroup, unknown>>, z.ZodObject<{
+        id: z.ZodString;
+        alias: z.ZodOptional<z.ZodString>;
+        autoFormat: z.ZodDefault<z.ZodBoolean>;
+        format: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+            type: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+                number: "number";
+                percent: "percent";
+                permille: "permille";
+                scientific: "scientific";
+            }>>>;
+            ratio: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+            symbol: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+            thousandSeparator: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+            prefix: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+            suffix: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+            fractionDigits: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+            significantDigits: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+            roundingPriority: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+                morePrecision: "morePrecision";
+                lessPrecision: "lessPrecision";
+            }>>>;
+            roundingMode: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+                floor: "floor";
+                ceil: "ceil";
+                expand: "expand";
+                trunc: "trunc";
+                halfCeil: "halfCeil";
+                halfFloor: "halfFloor";
+                halfExpand: "halfExpand";
+                halfTrunc: "halfTrunc";
+                halfEven: "halfEven";
+            }>>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>]>>>;
+    backgroundColor: z.ZodOptional<z.ZodOptional<z.ZodDefault<z.ZodString>>>;
+    color: z.ZodOptional<z.ZodObject<{
+        colorScheme: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        colorMapping: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, z.core.$strip>>;
+    label: z.ZodOptional<z.ZodObject<{
+        enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    }, z.core.$strip>>;
+    legend: z.ZodOptional<z.ZodObject<{
+        enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        border: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        maxSize: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        shapeType: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+            circle: "circle";
+            cross: "cross";
+            diamond: "diamond";
+            square: "square";
+            arrow: "arrow";
+            arrow2Left: "arrow2Left";
+            arrow2Right: "arrow2Right";
+            wedge: "wedge";
+            thinTriangle: "thinTriangle";
+            triangle: "triangle";
+            triangleUp: "triangleUp";
+            triangleDown: "triangleDown";
+            triangleRight: "triangleRight";
+            triangleLeft: "triangleLeft";
+            stroke: "stroke";
+            star: "star";
+            wye: "wye";
+            rect: "rect";
+            arrowLeft: "arrowLeft";
+            arrowRight: "arrowRight";
+            rectRound: "rectRound";
+            roundLine: "roundLine";
+        }>>>;
+        position: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+            left: "left";
+            leftTop: "leftTop";
+            leftBottom: "leftBottom";
+            lt: "lt";
+            lb: "lb";
+            top: "top";
+            topLeft: "topLeft";
+            topRight: "topRight";
+            tl: "tl";
+            tr: "tr";
+            right: "right";
+            rightTop: "rightTop";
+            rightBottom: "rightBottom";
+            rt: "rt";
+            rb: "rb";
+            bottom: "bottom";
+            bottomLeft: "bottomLeft";
+            bottomRight: "bottomRight";
+            bl: "bl";
+            br: "br";
+        }>>>;
+        labelFontSize: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        labelFontColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+        labelFontWeight: z.ZodOptional<z.ZodDefault<z.ZodUnion<[z.ZodNumber, z.ZodString]>>>;
+    }, z.core.$strip>>;
+    tooltip: z.ZodOptional<z.ZodObject<{
+        enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    }, z.core.$strip>>;
+    theme: z.ZodOptional<z.ZodString>;
+    locale: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+        "zh-CN": "zh-CN";
+        "en-US": "en-US";
+    }>>>;
+}, z.core.$strip>;

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

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-export type ChartType = 'table' | 'pivotTable' | 'line' | 'column' | 'columnPercent' | 'columnParallel' | 'bar' | 'barPercent' | 'barParallel' | 'area' | 'areaPercent' | 'rose' | 'roseParallel' | 'pie' | 'donut' | 'dualAxis' | 'scatter' | 'funnel';
+export type ChartType = 'table' | 'pivotTable' | 'line' | 'column' | 'columnPercent' | 'columnParallel' | 'bar' | 'barPercent' | 'barParallel' | 'area' | 'areaPercent' | 'areaRange' | 'scatter' | 'dualAxis' | 'rose' | 'roseParallel' | 'pie' | 'donut' | 'radar' | 'heatmap' | 'funnel';
 export declare enum ChartTypeEnum {
     Table = "table",
     PivotTable = "pivotTable",
@@ -12,13 +12,16 @@ export declare enum ChartTypeEnum {
     BarParallel = "barParallel",
     Area = "area",
     AreaPercent = "areaPercent",
+    AreaRange = "areaRange",
+    DualAxis = "dualAxis",
+    Scatter = "scatter",
     Rose = "rose",
     RoseParallel = "roseParallel",
     Pie = "pie",
     Donut = "donut",
-    DualAxis = "dualAxis",
-    Scatter = "scatter",
-    Funnel = "funnel"
+    Radar = "radar",
+    Funnel = "funnel",
+    Heatmap = "heatmap"
 }
 export declare const zChartType: z.ZodEnum<{
     table: "table";
@@ -32,11 +35,14 @@ export declare const zChartType: z.ZodEnum<{
     barParallel: "barParallel";
     area: "area";
     areaPercent: "areaPercent";
+    areaRange: "areaRange";
+    scatter: "scatter";
+    dualAxis: "dualAxis";
     rose: "rose";
     roseParallel: "roseParallel";
     pie: "pie";
     donut: "donut";
-    dualAxis: "dualAxis";
-    scatter: "scatter";
+    radar: "radar";
+    heatmap: "heatmap";
     funnel: "funnel";
 }>;