@visactor/vseed 0.0.36 → 0.0.38

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

@@ -1 +1,2 @@
-export * from './table';
+export type * from './table';
+export * from './zTable';

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

@@ -1,123 +1,108 @@
-import { z } from 'zod';
 import { type Locale } from '../../i18n';
 import type { DimensionTree, MeasureTree } from '../../properties';
 import { type BackgroundColor, type Dataset, type Theme } from '../../properties';
 /**
- * 表格类型定义
  * @description 表格，适用于详细数据展示场景，行列分明，便于查看具体数值
  * 适用场景:
  * - 需要展示详细数据明细
  * - 数据项需要精确比对
  * - 展示多维度数据属性
+ * @warning
  * 数据要求:
  * - 至少1个维度字段
  * - 至少1个度量字段
  * - 维度字段会作为表格的列标题
  * 默认开启的功能:
  * - 默认开启排序、筛选、分页功能
+ * @recommend
+ * - 推荐字段配置: `任意`个指标, `任意`个维度
+ * - 支持数据重塑: 至少`任意`个指标, `任意`个维度
  */
 export interface Table {
     /**
-     * 表格
      * @description 标准表格组件，用于展示详细数据
      * @type {'table'}
      * @example 'table'
      */
     chartType: 'table';
     /**
-     * 数据集
      * @description 符合TidyData规范的且已经聚合的数据集，用于定义图表的数据来源和结构, 用户输入的数据集并不需要进行任何处理, 一个字段对应一列, 一个记录对应一行
      * @type {Array<Record<string|number, any>>}
      * @example [{id: 1, name: "A", value: 100}, {id: 2, name: "B", value: 200}]
      */
     dataset: Dataset;
     /**
-     * 维度
      * @description 表格的每个维度会对应一列
      * @type {Dimensions}
      * @example [{id: "name", alias: "名称"}]
      */
     dimensions?: DimensionTree;
     /**
-     * 指标
      * @description 表格的每个指标会对应一行, 并且天生支持指标组合.
      * @type {Measures}
      * @example [{id: "value", alias: "数值"}]
      */
     measures?: MeasureTree;
     /**
-     * 图表的背景颜色
      * @default transparent 默认为透明背景
      * @description 背景颜色可以是颜色字符串, 例如'red', 'blue', 也可以是hex, rgb或rgba'#ff0000', 'rgba(255,0,0,0.5)'
      */
     backgroundColor?: BackgroundColor;
     /**
-     * 图表的主题, 主题是优先级较低的功能配置, 包含所有图表类型共用的通用配置, 与单类图表类型共用的图表配置
+     * @description 表格的边框颜色
+     */
+    borderColor?: string;
+    /**
+     * @description 表格体的字体大小
+     */
+    bodyFontSize?: number;
+    /**
+     * @description 表格体的字体颜色
+     */
+    bodyFontColor?: string;
+    /**
+     * @description 表格体的背景颜色
+     */
+    bodyBackgroundColor?: string;
+    /**
+     * @description 列表头的字体大小
+     */
+    headerFontSize?: number;
+    /**
+     * @description 列表头的字体颜色
+     */
+    headerFontColor?: string;
+    /**
+     * @description 列表头的背景颜色
+     */
+    headerBackgroundColor?: string;
+    /**
+     * @description 鼠标悬浮在列表头的单元格时的背景颜色, 用于突出显示鼠标所在的单元格
+     */
+    hoverHeaderBackgroundColor?: string;
+    /**
+     * @description 鼠标悬浮在列表头的时, 整行的单元格的背景颜色, 用于突出显示鼠标所在的行
+     */
+    hoverHeaderInlineBackgroundColor?: string;
+    /**
+     * @description 选中的单元格的边框颜色, 用于突出显示选中的单元格
+     */
+    selectedBorderColor?: string;
+    /**
+     * @description 选中的单元格的背景颜色, 用于突出显示选中的单元格
+     */
+    selectedBackgroundColor?: string;
+    /**
      * @default light 默认为亮色主题
-     * @description 内置light与dark两种主题, 用户可以通过Builder自定义主题
+     * @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 zTable: z.ZodObject<{
-    chartType: z.ZodLiteral<"table">;
-    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>>>;
-    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/table/zTable.d.ts

@@ -0,0 +1,68 @@
+import { z } from 'zod';
+export declare const zTable: z.ZodObject<{
+    chartType: z.ZodLiteral<"table">;
+    dataset: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodRecord<z.ZodUnion<[z.ZodString, z.ZodNumber]>, z.ZodAny>>>>;
+    dimensions: z.ZodOptional<z.ZodNullable<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.ZodNullable<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.ZodNullable<z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodString>>>>>;
+    borderColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    bodyFontSize: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    bodyFontColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    bodyBackgroundColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    hoverBodyBackgroundColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    hoverBodyInlineBackgroundColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    headerFontSize: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    headerFontColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    headerBackgroundColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    hoverHeaderBackgroundColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    hoverHeaderInlineBackgroundColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    selectedBorderColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    selectedBackgroundColor: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    theme: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    locale: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodEnum<{
+        "zh-CN": "zh-CN";
+        "en-US": "en-US";
+    }>>>>;
+}, z.core.$strip>;

package/dist/types/dataSelector/selector.d.ts

@@ -2,23 +2,77 @@ import { z } from 'zod';
 import type { Datum } from '../properties';
 export type ValueSelector = string | number;
 export type PartialDatumSelector = Datum;
+/**
+ * @description 指标选择器, 用于选择数据项中指标字段的值
+ */
 export type MeasureSelector = {
+    /**
+     * @description 指标字段, measures 某一项的 id
+     */
     field: string;
+    /**
+     * @description 操作符
+     * - =: 选择数据项中指标字段的值等于 value 的数据项
+     * - ==: 选择数据项中指标字段的值等于 value 的数据项
+     * - !=: 选择数据项中指标字段的值不等于 value 的数据项
+     * - >: 选择数据项中指标字段的值大于 value 的数据项
+     * - <: 选择数据项中指标字段的值小于 value 的数据项
+     * - >=: 选择数据项中指标字段的值大于等于 value 的数据项
+     * - <=: 选择数据项中指标字段的值小于等于 value 的数据项
+     * - between: 选择数据项中指标字段的值在 value 之间的 data item
+     */
     operator?: '=' | '==' | '!=' | '>' | '<' | '>=' | '<=' | 'between';
+    /**
+     * @description 操作符
+     * - =: 选择数据项中指标字段的值等于 value 的数据项
+     * - ==: 选择数据项中指标字段的值等于 value 的数据项
+     * - !=: 选择数据项中指标字段的值不等于 value 的数据项
+     * - >: 选择数据项中指标字段的值大于 value 的数据项
+     * - <: 选择数据项中指标字段的值小于 value 的数据项
+     * - >=: 选择数据项中指标字段的值大于等于 value 的数据项
+     * - <=: 选择数据项中指标字段的值小于等于 value 的数据项
+     * - between: 选择数据项中指标字段的值在 value 之间的 data item
+     * same as operator
+     */
     op?: '=' | '==' | '!=' | '>' | '<' | '>=' | '<=' | 'between';
+    /**
+     * @description 选择数据项中指标字段的值
+     * - 仅 op 为 between 时, value 为长度为2的数组, 数组中的元素为指标字段的最小值和最大值
+     * - 其他情况, value 为指标字段的单个值
+     */
     value: string | number | Array<string | number>;
 };
+/**
+ * @description 维度选择器, 用于选择数据项中维度字段的值
+ */
 export type DimensionSelector = {
+    /**
+     * @description 维度字段, dimensions 某一项的 id
+     */
     field: string;
+    /**
+     * @description 操作符
+     * - in: 选择数据项中维度字段的值在 value 中的数据项
+     * - not in: 选择数据项中维度字段的值不在 value 中的数据项
+     */
     operator?: 'in' | 'not in';
+    /**
+     * @description 操作符
+     * - in: 选择数据项中维度字段的值在 value 中的数据项
+     * - not in: 选择数据项中维度字段的值不在 value 中的数据项
+     * same as operator
+     */
     op?: 'in' | 'not in';
+    /**
+     * @description 选择数据项中维度字段的值, 支持数组
+     */
     value: string | number | Array<string | number>;
 };
 export type Selector = ValueSelector | PartialDatumSelector | MeasureSelector | DimensionSelector;
 export type Selectors = Array<Selector>;
 export declare const zSelector: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
     field: z.ZodString;
-    operator: z.ZodOptional<z.ZodEnum<{
+    operator: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         "=": "=";
         "==": "==";
         "!=": "!=";
@@ -27,8 +81,8 @@ export declare const zSelector: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z
         ">=": ">=";
         "<=": "<=";
         between: "between";
-    }>>;
-    op: z.ZodOptional<z.ZodEnum<{
+    }>>>;
+    op: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         "=": "=";
         "==": "==";
         "!=": "!=";
@@ -37,23 +91,23 @@ export declare const zSelector: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z
         ">=": ">=";
         "<=": "<=";
         between: "between";
-    }>>;
+    }>>>;
     value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>]>;
 }, z.core.$strip>, z.ZodObject<{
     field: z.ZodString;
-    operator: z.ZodOptional<z.ZodEnum<{
+    operator: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         in: "in";
         "not in": "not in";
-    }>>;
-    op: z.ZodOptional<z.ZodEnum<{
+    }>>>;
+    op: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         in: "in";
         "not in": "not in";
-    }>>;
+    }>>>;
     value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>]>;
 }, z.core.$strip>]>;
 export declare const zSelectors: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{
     field: z.ZodString;
-    operator: z.ZodOptional<z.ZodEnum<{
+    operator: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         "=": "=";
         "==": "==";
         "!=": "!=";
@@ -62,8 +116,8 @@ export declare const zSelectors: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.
         ">=": ">=";
         "<=": "<=";
         between: "between";
-    }>>;
-    op: z.ZodOptional<z.ZodEnum<{
+    }>>>;
+    op: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         "=": "=";
         "==": "==";
         "!=": "!=";
@@ -72,17 +126,17 @@ export declare const zSelectors: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.
         ">=": ">=";
         "<=": "<=";
         between: "between";
-    }>>;
+    }>>>;
     value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>]>;
 }, z.core.$strip>, z.ZodObject<{
     field: z.ZodString;
-    operator: z.ZodOptional<z.ZodEnum<{
+    operator: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         in: "in";
         "not in": "not in";
-    }>>;
-    op: z.ZodOptional<z.ZodEnum<{
+    }>>>;
+    op: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         in: "in";
         "not in": "not in";
-    }>>;
+    }>>>;
     value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>]>;
 }, z.core.$strip>]>>;

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

@@ -1,4 +1,4 @@
 import { z } from 'zod';
 export declare const zAnalysis: z.ZodObject<{
-    orderMapping: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>>;
+    orderMapping: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>>>;
 }, z.core.$strip>;

package/dist/types/properties/analysis/sort.d.ts

@@ -4,8 +4,8 @@ export declare const zSort: z.ZodObject<{
         asc: "asc";
         desc: "desc";
     }>>;
-    orderBy: z.ZodOptional<z.ZodString>;
-    customOrder: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+    orderBy: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    customOrder: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodAny>>>;
 }, z.core.$strip>;
 /**
  * @description 类目轴排序配置, 支持根据维度或指标排序, 以及自定义排序顺序
@@ -19,14 +19,12 @@ export declare const zSort: z.ZodObject<{
 export type Sort = {
     /**
      * @description 排序顺序, 可选值为 'asc' 或 'desc'
-     * @default 'asc'
      * @enum ['asc', 'desc']
      * @example order:'asc'
      */
     order?: 'asc' | 'desc';
     /**
      * @description 排序依赖的字段, 可以是维度id或指标id
-     * @default ''
      * @example
      * - orderBy:'date'
      * - orderBy:'profit'

package/dist/types/properties/analysis/sortLegend.d.ts

@@ -4,8 +4,8 @@ export declare const zSortLegend: z.ZodObject<{
         asc: "asc";
         desc: "desc";
     }>>;
-    orderBy: z.ZodOptional<z.ZodString>;
-    customOrder: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+    orderBy: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    customOrder: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodAny>>>;
 }, z.core.$strip>;
 /**
  * @description 图例排序配置, 支持根据维度或指标排序, 以及自定义排序顺序; 排序数组遵循从左到右或从上到下的顺序
@@ -26,7 +26,6 @@ export type SortLegend = {
     order?: 'asc' | 'desc';
     /**
      * @description 排序依赖的字段, 可以是维度id或指标id
-     * @default ''
      * @example
      * - orderBy:'date'
      * - orderBy:'profit'