@visactor/vseed 0.0.16 → 0.0.18

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

@@ -0,0 +1,224 @@
+import { z } from 'zod';
+import type { Locale } from '../../i18n';
+import type { BackgroundColor, Color, Dataset, Dimensions, Label, Legend, Measures, Theme, Tooltip } from '../../properties';
+/**
+ * 漏斗图
+ * @description 漏斗图，用于展示单一维度数据的占比关系
+ * 适用场景:
+ * 漏斗图适用场景:
+ * - 适合用来分析具有多个连续、规范化步骤的流程，并清晰地展示在每个环节的数据流失或转化情况
+ * 数据要求:
+ * - 至少1个数值字段（指标）
+ * - 所有维度会与指标名称(存在多个指标时)合并成一个维度, 作为图例项展示
+ * - 所有指标会自动合并为一个指标
+ * 默认开启的功能:
+ * - 默认开启图例、数据标签、提示信息、占比计算
+ */
+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 {Measures}
+     * @example [{id: 'value', alias: '数值占比', format: 'percent'}]
+     */
+    measures?: Measures;
+    /**
+     * 图表的背景颜色
+     * @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 zFunnel: z.ZodObject<{
+    chartType: z.ZodLiteral<"funnel">;
+    dataset: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodUnion<[z.ZodString, z.ZodNumber]>, z.ZodAny>>>;
+    dimensions: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        alias: z.ZodOptional<z.ZodString>;
+        visible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        location: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+            dimension: "dimension";
+            rowDimension: "rowDimension";
+            columnDimension: "columnDimension";
+        }>>>;
+    }, z.core.$strip>>>>;
+    measures: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodObject<{
+        id: z.ZodString;
+        alias: z.ZodOptional<z.ZodString>;
+        visible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        children: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodObject</*elided*/ any, z.core.$strip>, z.ZodObject<{
+            id: z.ZodString;
+            alias: z.ZodOptional<z.ZodString>;
+            visible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+            autoFormat: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+            format: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodObject<{
+                type: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+                    number: "number";
+                    percent: "percent";
+                    permille: "permille";
+                }>>>;
+                ratio: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+                symbol: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+                thousandSeparator: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+                decimalPlaces: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+                round: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+                    round: "round";
+                    floor: "floor";
+                    ceil: "ceil";
+                }>>>;
+                prefix: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+                suffix: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+            }, z.core.$strip>>>>;
+        }, z.core.$strip>]>>>;
+    }, z.core.$strip>, z.ZodObject<{
+        id: z.ZodString;
+        alias: z.ZodOptional<z.ZodString>;
+        visible: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        autoFormat: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        format: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodObject<{
+            type: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+                number: "number";
+                percent: "percent";
+                permille: "permille";
+            }>>>;
+            ratio: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+            symbol: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+            thousandSeparator: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+            decimalPlaces: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+            round: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+                round: "round";
+                floor: "floor";
+                ceil: "ceil";
+            }>>>;
+            prefix: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+            suffix: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+        }, 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>;
+//# sourceMappingURL=funnel.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"funnel.d.ts","sourceRoot":"","sources":["../../../../src/types/chartType/funnel/funnel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAaxC,OAAO,KAAK,EACV,eAAe,EACf,KAAK,EACL,OAAO,EACP,UAAU,EACV,KAAK,EACL,MAAM,EACN,QAAQ,EACR,KAAK,EACL,OAAO,EACR,MAAM,kBAAkB,CAAA;AAEzB;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,MAAM;IACrB;;;;;OAKG;IACH,SAAS,EAAE,QAAQ,CAAA;IACnB;;;;;OAKG;IACH,OAAO,EAAE,OAAO,CAAA;IAEhB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,UAAU,CAAA;IAEvB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAA;IAEnB;;;;OAIG;IACH,eAAe,CAAC,EAAE,eAAe,CAAA;IAEjC;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;IAEb;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;IAEb;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;IAEb;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAYlB,CAAA"}

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

@@ -0,0 +1,2 @@
+export * from './funnel';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/types/chartType/funnel/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA"}

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

@@ -14,4 +14,6 @@ export * from './rose';
 export * from './roseParallel';
 export * from './pie';
 export * from './donut';
+export * from './scatter';
+export * from './funnel';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/chartType/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,SAAS,CAAA;AAC5B,mBAAmB,cAAc,CAAA;AACjC,mBAAmB,YAAY,CAAA;AAE/B,cAAc,QAAQ,CAAA;AACtB,cAAc,UAAU,CAAA;AACxB,cAAc,kBAAkB,CAAA;AAChC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,OAAO,CAAA;AACrB,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAC5B,cAAc,QAAQ,CAAA;AACtB,cAAc,eAAe,CAAA;AAC7B,cAAc,QAAQ,CAAA;AACtB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,OAAO,CAAA;AACrB,cAAc,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/chartType/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,SAAS,CAAA;AAC5B,mBAAmB,cAAc,CAAA;AACjC,mBAAmB,YAAY,CAAA;AAE/B,cAAc,QAAQ,CAAA;AACtB,cAAc,UAAU,CAAA;AACxB,cAAc,kBAAkB,CAAA;AAChC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,OAAO,CAAA;AACrB,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAC5B,cAAc,QAAQ,CAAA;AACtB,cAAc,eAAe,CAAA;AAC7B,cAAc,QAAQ,CAAA;AACtB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,OAAO,CAAA;AACrB,cAAc,SAAS,CAAA;AACvB,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA"}