@visactor/vseed 0.0.21 → 0.0.23

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

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

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

@@ -1,5 +1,5 @@
 import { type Locale } from '../../i18n';
-import type { MeasureTree } from '../../properties';
+import type { MeasureTree, SortAxis, SortLegend } from '../../properties';
 import { type AnnotationArea, type AnnotationHorizontalLine, type AnnotationPoint, type AnnotationVerticalLine, type BackgroundColor, type BarStyle, type Color, type CrosshairRect, type Dataset, type Dimensions, type Label, type Legend, type StackCornerRadius, type Theme, type Tooltip, type XLinearAxis, type YBandAxis } from '../../properties';
 import { z } from 'zod';
 /**
@@ -92,6 +92,30 @@ export interface Bar {
      * @default 8
      */
     stackCornerRadius?: StackCornerRadius;
+    /**
+     * @description Y轴排序配置, 支持根据维度或指标排序, 以及自定义排序顺序
+     * @example
+     * sortAxis: {
+     *   orderBy: 'profit',
+     *   order: 'asc',
+     * }
+     * sortAxis: {
+     *   customOrder:['2019', '2020', '2021']
+     * }
+     */
+    sortAxis?: SortAxis;
+    /**
+     * @description 图例排序配置, 支持根据维度或指标排序, 以及自定义排序顺序
+     * @example
+     * sortLegend: {
+     *   orderBy: 'profit',
+     *   order: 'asc',
+     * }
+     * sortLegend: {
+     *   customOrder:['2019', '2020', '2021']
+     * }
+     */
+    sortLegend?: SortLegend;
     /**
      * 图表的主题, 主题是优先级较低的功能配置, 包含所有图表类型共用的通用配置, 与单类图表类型共用的图表配置
      * @default light 默认为亮色主题

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

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 import type { Locale } from '../../i18n';
-import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XLinearAxis, YBandAxis, MeasureTree } from '../../properties';
+import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XLinearAxis, YBandAxis, MeasureTree, SortAxis, SortLegend } from '../../properties';
 /**
  * 并列条形图类型定义
  * @description 并列条形图，适用于多指标横向并行对比场景，多个条形平行排列展示不同指标值
@@ -91,6 +91,30 @@ export interface BarParallel {
      * @default 8
      */
     stackCornerRadius?: StackCornerRadius;
+    /**
+     * @description Y轴排序配置, 支持根据维度或指标排序, 以及自定义排序顺序
+     * @example
+     * sortAxis: {
+     *   orderBy: 'profit',
+     *   order: 'asc',
+     * }
+     * sortAxis: {
+     *   customOrder:['2019', '2020', '2021']
+     * }
+     */
+    sortAxis?: SortAxis;
+    /**
+     * @description 图例排序配置, 支持根据维度或指标排序, 以及自定义排序顺序
+     * @example
+     * sortLegend: {
+     *   orderBy: 'profit',
+     *   order: 'asc',
+     * }
+     * sortLegend: {
+     *   customOrder:['2019', '2020', '2021']
+     * }
+     */
+    sortLegend?: SortLegend;
     /**
      * 图表的主题, 主题是优先级较低的功能配置, 包含所有图表类型共用的通用配置, 与单类图表类型共用的图表配置
      * @default light 默认为亮色主题

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

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 import type { Locale } from '../../i18n';
-import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XLinearAxis, YBandAxis, MeasureTree } from '../../properties';
+import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XLinearAxis, YBandAxis, MeasureTree, SortAxis, SortLegend } from '../../properties';
 /**
  * 百分比条形图类型定义
  * @description 百分比条形图，适用于横向展示各类别占比关系的场景，X轴以百分比形式展示数据占比
@@ -91,6 +91,30 @@ export interface BarPercent {
      * @default 8
      */
     stackCornerRadius?: StackCornerRadius;
+    /**
+     * @description Y轴排序配置, 支持根据维度或指标排序, 以及自定义排序顺序
+     * @example
+     * sortAxis: {
+     *   orderBy: 'profit',
+     *   order: 'asc',
+     * }
+     * sortAxis: {
+     *   customOrder:['2019', '2020', '2021']
+     * }
+     */
+    sortAxis?: SortAxis;
+    /**
+     * @description 图例排序配置, 支持根据维度或指标排序, 以及自定义排序顺序
+     * @example
+     * sortLegend: {
+     *   orderBy: 'profit',
+     *   order: 'asc',
+     * }
+     * sortLegend: {
+     *   customOrder:['2019', '2020', '2021']
+     * }
+     */
+    sortLegend?: SortLegend;
     /**
      * 图表的主题, 主题是优先级较低的功能配置, 包含所有图表类型共用的通用配置, 与单类图表类型共用的图表配置
      * @default light 默认为亮色主题

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

@@ -1,5 +1,5 @@
 import type { Locale } from '../../i18n';
-import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XBandAxis, YLinearAxis, MeasureTree } from '../../properties';
+import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XBandAxis, YLinearAxis, MeasureTree, SortAxis, SortLegend } from '../../properties';
 import { z } from 'zod';
 /**
  * 柱状图类型定义
@@ -80,6 +80,30 @@ export interface Column {
      * @description 数值轴, y轴配置, 用于定义图表的y轴, 包括y轴的位置, 格式, 样式等.
      */
     yAxis?: YLinearAxis;
+    /**
+     * @description X轴排序配置, 支持根据维度或指标排序, 以及自定义排序顺序
+     * @example
+     * sortAxis: {
+     *   orderBy: 'profit',
+     *   order: 'asc',
+     * }
+     * sortAxis: {
+     *   customOrder:['2019', '2020', '2021']
+     * }
+     */
+    sortAxis?: SortAxis;
+    /**
+     * @description 图例排序配置, 支持根据维度或指标排序, 以及自定义排序顺序
+     * @example
+     * sortLegend: {
+     *   orderBy: 'profit',
+     *   order: 'asc',
+     * }
+     * sortLegend: {
+     *   customOrder:['2019', '2020', '2021']
+     * }
+     */
+    sortLegend?: SortLegend;
     /**
      * 图表的主题, 主题是优先级较低的功能配置, 包含所有图表类型共用的通用配置, 与单类图表类型共用的图表配置
      * @default light 默认为亮色主题

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

@@ -1,5 +1,5 @@
 import type { Locale } from '../../i18n';
-import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XBandAxis, YLinearAxis, MeasureTree } from '../../properties';
+import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XBandAxis, YLinearAxis, MeasureTree, SortLegend, SortAxis } from '../../properties';
 import { z } from 'zod';
 /**
  * 并列柱状图类型定义
@@ -91,6 +91,30 @@ export interface ColumnParallel {
      * @default 8
      */
     stackCornerRadius?: StackCornerRadius;
+    /**
+     * @description X轴排序配置, 支持根据维度或指标排序, 以及自定义排序顺序
+     * @example
+     * sortAxis: {
+     *   orderBy: 'profit',
+     *   order: 'asc',
+     * }
+     * sortAxis: {
+     *   customOrder:['2019', '2020', '2021']
+     * }
+     */
+    sortAxis?: SortAxis;
+    /**
+     * @description 图例排序配置, 支持根据维度或指标排序, 以及自定义排序顺序
+     * @example
+     * sortLegend: {
+     *   orderBy: 'profit',
+     *   order: 'asc',
+     * }
+     * sortLegend: {
+     *   customOrder:['2019', '2020', '2021']
+     * }
+     */
+    sortLegend?: SortLegend;
     /**
      * 图表的主题, 主题是优先级较低的功能配置, 包含所有图表类型共用的通用配置, 与单类图表类型共用的图表配置
      * @default light 默认为亮色主题

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

@@ -1,5 +1,5 @@
 import type { Locale } from '../../i18n';
-import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XBandAxis, YLinearAxis, MeasureTree } from '../../properties';
+import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, BarStyle, Color, CrosshairRect, Dataset, Dimensions, Label, Legend, StackCornerRadius, Theme, Tooltip, XBandAxis, YLinearAxis, MeasureTree, SortAxis, SortLegend } from '../../properties';
 import { z } from 'zod';
 /**
  * 百分比柱状图类型定义
@@ -91,6 +91,30 @@ export interface ColumnPercent {
      * @default 8
      */
     stackCornerRadius?: StackCornerRadius;
+    /**
+     * @description X轴排序配置, 支持根据维度或指标排序, 以及自定义排序顺序
+     * @example
+     * sortAxis: {
+     *   orderBy: 'profit',
+     *   order: 'asc',
+     * }
+     * sortAxis: {
+     *   customOrder:['2019', '2020', '2021']
+     * }
+     */
+    sortAxis?: SortAxis;
+    /**
+     * @description 图例排序配置, 支持根据维度或指标排序, 以及自定义排序顺序
+     * @example
+     * sortLegend: {
+     *   orderBy: 'profit',
+     *   order: 'asc',
+     * }
+     * sortLegend: {
+     *   customOrder:['2019', '2020', '2021']
+     * }
+     */
+    sortLegend?: SortLegend;
     /**
      * 图表的主题, 主题是优先级较低的功能配置, 包含所有图表类型共用的通用配置, 与单类图表类型共用的图表配置
      * @default light 默认为亮色主题

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

@@ -9,6 +9,7 @@ export * from './barParallel';
 export * from './barPercent';
 export * from './area';
 export * from './areaPercent';
+export * from './areaRange';
 export * from './rose';
 export * from './roseParallel';
 export * from './pie';

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

@@ -1,5 +1,5 @@
 import type { Locale } from '../../i18n';
-import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, Color, Dataset, Dimensions, Label, Legend, LineStyle, PointStyle, Theme, Tooltip, CrosshairLine, XBandAxis, YLinearAxis, MeasureTree } from '../../properties';
+import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, Color, Dataset, Dimensions, Label, Legend, LineStyle, PointStyle, Theme, Tooltip, CrosshairLine, XBandAxis, YLinearAxis, MeasureTree, SortAxis, SortLegend } from '../../properties';
 import { z } from 'zod';
 /**
  * 折线图类型定义
@@ -85,6 +85,30 @@ export interface Line {
      * @description  鼠标移动到图表上时, 显示的垂直提示线
      */
     crosshairLine?: CrosshairLine;
+    /**
+     * @description X轴排序配置, 支持根据维度或指标排序, 以及自定义排序顺序
+     * @example
+     * sortAxis: {
+     *   orderBy: 'profit',
+     *   order: 'asc',
+     * }
+     * sortAxis: {
+     *   customOrder:['2019', '2020', '2021']
+     * }
+     */
+    sortAxis?: SortAxis;
+    /**
+     * @description 图例排序配置, 支持根据维度或指标排序, 以及自定义排序顺序
+     * @example
+     * sortLegend: {
+     *   orderBy: 'profit',
+     *   order: 'asc',
+     * }
+     * sortLegend: {
+     *   customOrder:['2019', '2020', '2021']
+     * }
+     */
+    sortLegend?: SortLegend;
     /**
      * 图表的主题, 主题是优先级较低的功能配置, 包含所有图表类型共用的通用配置, 与单类图表类型共用的图表配置
      * @default light 默认为亮色主题
@@ -337,6 +361,22 @@ export declare const zLine: z.ZodObject<{
         labelVisible: z.ZodOptional<z.ZodBoolean>;
         labelBackgroundColor: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;
+    sortAxis: z.ZodOptional<z.ZodObject<{
+        order: z.ZodDefault<z.ZodEnum<{
+            asc: "asc";
+            desc: "desc";
+        }>>;
+        orderBy: z.ZodOptional<z.ZodString>;
+        customOrder: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+    }, z.core.$strip>>;
+    sortLegend: z.ZodOptional<z.ZodObject<{
+        order: z.ZodDefault<z.ZodEnum<{
+            asc: "asc";
+            desc: "desc";
+        }>>;
+        orderBy: z.ZodOptional<z.ZodString>;
+        customOrder: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+    }, z.core.$strip>>;
     theme: z.ZodOptional<z.ZodString>;
     pointStyle: z.ZodOptional<z.ZodObject<{
         selector: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodObject<{

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

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

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

@@ -0,0 +1,3 @@
+export * from './sortAxis';
+export * from './sortLegend';
+export * from './analysis';

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

@@ -0,0 +1,39 @@
+import { z } from 'zod';
+export declare const zSortAxis: z.ZodObject<{
+    order: z.ZodDefault<z.ZodEnum<{
+        asc: "asc";
+        desc: "desc";
+    }>>;
+    orderBy: z.ZodOptional<z.ZodString>;
+    customOrder: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+}, z.core.$strip>;
+/**
+ * @description 类目轴排序配置, 支持根据维度或指标排序, 以及自定义排序顺序
+ * @default {}
+ * @example
+ * - order:'asc'
+ * - orderBy:'date'
+ * 或
+ * - customOrder:['2019', '2020', '2021']
+ */
+export type SortAxis = {
+    /**
+     * @description 排序顺序, 可选值为 'asc' 或 'desc'
+     * @default 'asc'
+     * @enum ['asc', 'desc']
+     * @example order:'asc'
+     */
+    order?: 'asc' | 'desc';
+    /**
+     * @description 排序依赖的字段, 可以是维度id或指标id
+     * @default ''
+     * @example
+     * - orderBy:'date'
+     * - orderBy:'profit'
+     */
+    orderBy?: string;
+    /**
+     * @description 自定义排序顺序, 该顺序将直接应用至类目轴
+     */
+    customOrder?: string[];
+};

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

@@ -0,0 +1,39 @@
+import { z } from 'zod';
+export declare const zSortLegend: z.ZodObject<{
+    order: z.ZodDefault<z.ZodEnum<{
+        asc: "asc";
+        desc: "desc";
+    }>>;
+    orderBy: z.ZodOptional<z.ZodString>;
+    customOrder: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+}, z.core.$strip>;
+/**
+ * @description 图例排序配置, 支持根据维度或指标排序, 以及自定义排序顺序; 排序数组遵循从左到右或从上到下的顺序
+ * @default {}
+ * @example
+ * - order:'asc'
+ * - orderBy:'date'
+ * 或
+ * - customOrder:['2019', '2020', '2021']
+ */
+export type SortLegend = {
+    /**
+     * @description 排序顺序, 可选值为 'asc' 或 'desc'
+     * @default 'asc'
+     * @enum ['asc', 'desc']
+     * @example order:'asc'
+     */
+    order?: 'asc' | 'desc';
+    /**
+     * @description 排序依赖的字段, 可以是维度id或指标id
+     * @default ''
+     * @example
+     * - orderBy:'date'
+     * - orderBy:'profit'
+     */
+    orderBy?: string;
+    /**
+     * @description 自定义排序顺序, 该顺序将直接应用至图例, 升序从左到右或从上到下, 降序从右到左或从下到上
+     */
+    customOrder?: string[];
+};

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' | 'rose' | 'roseParallel' | 'pie' | 'donut' | 'dualAxis' | 'scatter' | 'funnel';
 export declare enum ChartTypeEnum {
     Table = "table",
     PivotTable = "pivotTable",
@@ -12,6 +12,7 @@ export declare enum ChartTypeEnum {
     BarParallel = "barParallel",
     Area = "area",
     AreaPercent = "areaPercent",
+    AreaRange = "areaRange",
     Rose = "rose",
     RoseParallel = "roseParallel",
     Pie = "pie",
@@ -32,6 +33,7 @@ export declare const zChartType: z.ZodEnum<{
     barParallel: "barParallel";
     area: "area";
     areaPercent: "areaPercent";
+    areaRange: "areaRange";
     rose: "rose";
     roseParallel: "roseParallel";
     pie: "pie";