@visactor/vseed 0.1.37 → 0.1.38

package/dist/esm/types/advancedVSeed.js

@@ -7,7 +7,7 @@ import { zEncoding } from "./properties/encoding/index.js";
 import { zDatasetReshapeInfo } from "./properties/datasetReshapeInfo/index.js";
 import { zCustomThemeConfig, zTheme } from "./properties/theme/index.js";
 import { zConfig } from "./properties/config/index.js";
-import { zAnalysis, zAnnotation, zMarkStyle } from "./properties/index.js";
+import { zAnalysis, zAnnotation, zHistogramRegressionLine, zMarkStyle } from "./properties/index.js";
 import { zLocale } from "./i18n/index.js";
 const zAdvancedVSeed = z.object({
     chartType: zChartType,
@@ -22,7 +22,8 @@ const zAdvancedVSeed = z.object({
     markStyle: zMarkStyle,
     customTheme: zCustomThemeConfig,
     annotation: zAnnotation,
-    locale: zLocale
+    locale: zLocale,
+    histogramRegressionLine: zHistogramRegressionLine.or(z.array(zHistogramRegressionLine)).nullish()
 });
 export { zAdvancedVSeed };
 

package/dist/esm/types/advancedVSeed.js.map

@@ -1 +1 @@
-{"version":3,"file":"types/advancedVSeed.js","sources":["webpack://@visactor/vseed/./src/types/advancedVSeed.ts"],"sourcesContent":["import { z } from 'zod'\nimport { zChartType } from './properties/chartType'\nimport { zDataset } from './properties/dataset'\nimport { zDimensionTree } from './properties/dimensions'\nimport { zMeasureTree } from './properties/measures'\nimport { zEncoding } from './properties/encoding'\nimport { zDatasetReshapeInfo } from './properties/datasetReshapeInfo'\nimport { zTheme, zCustomThemeConfig } from './properties/theme'\nimport { zConfig } from './properties/config'\nimport { zAnalysis, zAnnotation, zMarkStyle } from './properties'\nimport { zLocale } from './i18n'\n\nexport const zAdvancedVSeed = z.object({\n  chartType: zChartType,\n  dataset: zDataset,\n  datasetReshapeInfo: zDatasetReshapeInfo,\n  dimensions: zDimensionTree,\n  measures: zMeasureTree,\n  encoding: zEncoding,\n  config: zConfig,\n  analysis: zAnalysis,\n  theme: zTheme,\n  markStyle: zMarkStyle,\n  customTheme: zCustomThemeConfig,\n  annotation: zAnnotation,\n  locale: zLocale,\n})\n\nexport type AdvancedVSeed = z.infer<typeof zAdvancedVSeed>\n"],"names":["zAdvancedVSeed","z","zChartType","zDataset","zDatasetReshapeInfo","zDimensionTree","zMeasureTree","zEncoding","zConfig","zAnalysis","zTheme","zMarkStyle","zCustomThemeConfig","zAnnotation","zLocale"],"mappings":";;;;;;;;;;;AAYO,MAAMA,iBAAiBC,EAAE,MAAM,CAAC;IACrC,WAAWC;IACX,SAASC;IACT,oBAAoBC;IACpB,YAAYC;IACZ,UAAUC;IACV,UAAUC;IACV,QAAQC;IACR,UAAUC;IACV,OAAOC;IACP,WAAWC;IACX,aAAaC;IACb,YAAYC;IACZ,QAAQC;AACV"}
+{"version":3,"file":"types/advancedVSeed.js","sources":["webpack://@visactor/vseed/./src/types/advancedVSeed.ts"],"sourcesContent":["import { z } from 'zod'\nimport { zChartType } from './properties/chartType'\nimport { zDataset } from './properties/dataset'\nimport { zDimensionTree } from './properties/dimensions'\nimport { zMeasureTree } from './properties/measures'\nimport { zEncoding } from './properties/encoding'\nimport { zDatasetReshapeInfo } from './properties/datasetReshapeInfo'\nimport { zTheme, zCustomThemeConfig } from './properties/theme'\nimport { zConfig } from './properties/config'\nimport { zAnalysis, zAnnotation, zHistogramRegressionLine, zMarkStyle } from './properties'\nimport { zLocale } from './i18n'\n\nexport const zAdvancedVSeed = z.object({\n  chartType: zChartType,\n  dataset: zDataset,\n  datasetReshapeInfo: zDatasetReshapeInfo,\n  dimensions: zDimensionTree,\n  measures: zMeasureTree,\n  encoding: zEncoding,\n  config: zConfig,\n  analysis: zAnalysis,\n  theme: zTheme,\n  markStyle: zMarkStyle,\n  customTheme: zCustomThemeConfig,\n  annotation: zAnnotation,\n  locale: zLocale,\n  histogramRegressionLine: zHistogramRegressionLine.or(z.array(zHistogramRegressionLine)).nullish(),\n})\n\nexport type AdvancedVSeed = z.infer<typeof zAdvancedVSeed>\n"],"names":["zAdvancedVSeed","z","zChartType","zDataset","zDatasetReshapeInfo","zDimensionTree","zMeasureTree","zEncoding","zConfig","zAnalysis","zTheme","zMarkStyle","zCustomThemeConfig","zAnnotation","zLocale","zHistogramRegressionLine"],"mappings":";;;;;;;;;;;AAYO,MAAMA,iBAAiBC,EAAE,MAAM,CAAC;IACrC,WAAWC;IACX,SAASC;IACT,oBAAoBC;IACpB,YAAYC;IACZ,UAAUC;IACV,UAAUC;IACV,QAAQC;IACR,UAAUC;IACV,OAAOC;IACP,WAAWC;IACX,aAAaC;IACb,YAAYC;IACZ,QAAQC;IACR,yBAAyBC,yBAAyB,EAAE,CAACd,EAAE,KAAK,CAACc,2BAA2B,OAAO;AACjG"}

package/dist/esm/types/chartType/area/zArea.d.ts

@@ -15,6 +15,15 @@ export declare const zArea: z.ZodObject<{
         row: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         group: 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>>>;
+        median: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        min: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        max: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        outliers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        x0: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        x1: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
     }, z.core.$strip>>>;
     dimensions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
         id: z.ZodString;

package/dist/esm/types/chartType/areaPercent/zAreaPercent.d.ts

@@ -15,6 +15,15 @@ export declare const zAreaPercent: z.ZodObject<{
         row: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         group: 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>>>;
+        median: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        min: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        max: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        outliers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        x0: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        x1: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
     }, z.core.$strip>>>;
     dimensions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
         id: z.ZodString;

package/dist/esm/types/chartType/bar/zBar.d.ts

@@ -15,6 +15,15 @@ export declare const zBar: z.ZodObject<{
         row: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         group: 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>>>;
+        median: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        min: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        max: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        outliers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        x0: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        x1: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
     }, z.core.$strip>>>;
     dimensions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
         id: z.ZodString;

package/dist/esm/types/chartType/barParallel/zBarParallel.d.ts

@@ -15,6 +15,15 @@ export declare const zBarParallel: z.ZodObject<{
         row: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         group: 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>>>;
+        median: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        min: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        max: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        outliers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        x0: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        x1: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
     }, z.core.$strip>>>;
     dimensions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
         id: z.ZodString;

package/dist/esm/types/chartType/barPercent/zBarPercent.d.ts

@@ -15,6 +15,15 @@ export declare const zBarPercent: z.ZodObject<{
         row: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         column: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         group: 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>>>;
+        median: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        min: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        max: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        outliers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        x0: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        x1: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
     }, z.core.$strip>>>;
     dimensions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
         id: z.ZodString;

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

@@ -0,0 +1,144 @@
+import type { Locale } from '../../i18n';
+import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, Theme, Tooltip, XBandAxis, YLinearAxis, MeasureTree, Sort, SortLegend, WhiskersConfig } from '../../properties';
+/**
+ * @description 箱线图，适用于展示数据分布情况，X轴为类目轴（分类数据），Y轴为数值轴（连续数据），箱体纵向排列
+ * 适用场景:
+ * - 数据项名称较短时
+ * - 需要直观比较不同类别的数值大小
+ * - 展示时间序列数据变化趋势
+ * @encoding
+ * 箱线图支持以下视觉通道:
+ * `xAxis`  : x轴通道, 支持`多个维度`, 按维度值映射至x轴
+ * `yAxis`  : y轴通道, 支持`多个指标`, 按指标值映射至y轴
+ * `color`  : 颜色通道, 支持`多个维度`或 `一个指标`, 维度颜色用于区分不同的数据系列, 指标颜色用于线性映射指标值到图形颜色
+ * `tooltip`: 提示通道, 支持`多个维度`与 `多个指标`, 会在鼠标悬停在数据点上时展示
+ * `label`  : 标签通道, 支持`多个维度`与 `多个指标`, 会在数据点上展示数据标签
+ * @warning
+ * 数据要求:
+ * - 至少1个数值字段（度量）
+ * - 第一个维度会放至X轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示
+ * - 所有指标会自动合并为一个指标
+ * 默认开启的功能:
+ * - 默认开启图例、坐标轴、数据标签、提示信息
+ * @recommend
+ * - 推荐字段配置: `1`个指标, `1`个维度
+ * - 支持数据重塑: 至少`1`个指标, `0`个维度
+ */
+export interface Boxplot {
+    /**
+     * @description 箱型图，适用于展示数据分布情况，X轴为类目轴（分类数据），Y轴为数值轴（连续数据），箱体纵向排列
+     * @type {'boxPlot'}
+     * @example 'boxPlot'
+     */
+    chartType: 'boxPlot';
+    /**
+     * @description 符合TidyData规范的且已经聚合的数据集，用于定义图表的数据来源和结构, 用户输入的数据集并不需要进行任何处理, VSeed带有强大的数据重塑功能, 会自行进行数据重塑, 柱状图的数据最终会被转换为2个维度, 1个指标.
+     * @type {Array<Record<string|number, any>>}
+     * @example [{category:'A', value:100}, {category:'B', value:200}]
+     */
+    dataset: Dataset;
+    /**
+     * @description 箱线图的第一个维度被映射到X轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示
+     * @type {Dimensions}
+     * @example [{id: "category", alias: "类别"}]
+     */
+    dimensions?: Dimensions;
+    /**
+     * @description 箱线图的所有指标会自动合并为一个指标, 映射到Y轴, 存在多个指标时, 指标名称会与其余维度合并, 作为图例项展示.
+     * @type {MeasureTree}
+     * @example [{id: "value", alias: "数值"}]
+     */
+    measures?: MeasureTree;
+    /**
+     * @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 x轴, 类目轴, x轴配置, 用于定义图表的x轴, 包括x轴的位置, 格式, 样式等.
+     */
+    xAxis?: XBandAxis;
+    /**
+     * @description y轴, 数值轴, y轴配置, 用于定义图表的y轴, 包括y轴的位置, 格式, 样式等.
+     */
+    yAxis?: YLinearAxis;
+    /**
+     * @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 垂直提示框配置, 用于定义图表的垂直提示框, 包括垂直提示框的颜色、标签样式等.
+     */
+    crosshairRect?: CrosshairRect;
+    /**
+     * @description 直方图的须长配置，支持标量值和长度为2 的数组
+     * 当值为标量的时候，使用 whiskers * IQR 来计算上界值和下界值
+     * 当值为2元数组的时候，whiskers[0] 需要在[0, 0.25)之间，表示下界值取对应的百分位数；
+     * whiskers[1] 需要在(0.75, 1]之间，表示上界值取对应的百分位数；
+     */
+    whiskers?: WhiskersConfig;
+    /**
+     * @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/boxplot/index.d.ts

@@ -0,0 +1,2 @@
+export type * from './boxplot';
+export * from './zBoxplot';

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

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