@visactor/vseed 0.0.30 → 0.0.32

package/dist/types/properties/annotation/annotationHorizontalLine.d.ts

@@ -1,18 +1,18 @@
 import { type Selector, type Selectors } from '../../dataSelector';
 import { z } from 'zod';
+/**
+ * @description 水平标注线, 根据用户设置的selector 或 yValue, 从左向右绘制一条末尾有箭头的线, 标签默认在标注线的终点正下方
+ */
 export type AnnotationHorizontalLine = {
     /**
-     * 依赖选择的数据, 进行数据标记.
+     * @description 依赖选择的数据, 进行数据标记.
      */
     selector?: Selector | Selectors;
     /**
-     * 固定的y值, 用于标注水平线
-     * @description 类目轴在y方向, 则可输入维值, 数值轴在y方向, 则可输入具体的数值
-     * @default []
+     * @description  固定的y值, 用于标注水平线, 类目轴在y方向, 则可输入维值, 数值轴在y方向, 则可输入具体的数值
      */
     yValue?: (number | string) | (number | string)[];
     /**
-     * 标注的文本
      * @description 标注的文本
      * @default ''
      * @example '标注文本'
@@ -21,126 +21,105 @@ export type AnnotationHorizontalLine = {
     /**
      * 文本位置
      * @description 标注线的标签位置（标签相对线的相对位置）。
-     * @default 'insideEnd'
      * @example 'outsideEnd'
      */
     textPosition?: 'outsideStart' | 'outsideEnd' | 'outsideMiddle' | 'insideStart' | 'insideMiddle' | 'insideEnd';
     /**
-     * 文本颜色
      * @description 文本颜色
-     * @default '#ffffff'
      * @example 'red'
      */
     textColor?: string;
     /**
-     * 文本字体大小
      * @description 文本字体大小
-     * @default 12
      * @example 12
      */
     textFontSize?: number;
     /**
-     * 文本字体重量
      * @description 文本字体重量
-     * @default 400
      * @example 400
      */
     textFontWeight?: number;
     /**
-     * 文本对齐方式
-     * @description 文本对齐方式
-     * @default 'left'
-     * @example 'center'
+     * @description 文本对齐方式, 一般情况下, 无需设置
+     * 建议设置为'right', 这样可以确保文本在标注线的左侧
+     * right: 文本在参考线的左侧, 文本的右侧边缘对齐(水平)标注线的终点
+     * left: 文本在参考线的右侧, 文本的左侧边缘对齐(水平)标注线的终点
+     * center: 文本在参考线的中心, 文本的中心对齐(水平)标注线的终点
+     * @example 'right'
      */
     textAlign?: 'left' | 'right' | 'center';
     /**
-     * 文本垂直对齐方式
-     * @description 文本垂直对齐方式
-     * @default 'bottom'
-     * @example 'middle'
+     * @description 文本垂直对齐方式, 一般情况下, 无需设置
+     * 建议设置为'top', 这样可以确保文本完整的显示在图表的可见区域
+     * top: 文本在参考线的底部, 文本的顶部边缘对齐(水平)标注线
+     * middle: 文本在参考线的中心, 文本的中心对齐(水平)标注线
+     * bottom: 文本在参考线的顶部, 文本的底部边缘对齐(水平)标注线
+     * @example 'top'
      */
     textBaseline?: 'top' | 'middle' | 'bottom';
     /**
-     * 文本Y方向的, 偏移量
-     * @description 文本Y方向的, 偏移量, 支持正负
-     * @default 0
-     * @example offsetY: 10
+     * @description (水平)标注线整体在Y方向的偏移像素距离, 一般情况下, 无需设置
+     * 负值则整体向上偏移, 例如设置为-10, 则整个(水平)标注线组件包括文本、箭头、线段, 一起向上偏移10像素
+     * 正值则整体向下偏移, 例如设置为10, 则整个(水平)标注线组件包括文本、箭头、线段, 一起向下偏移10像素
+     * @example offsetY: 0
      */
     offsetY?: number;
     /**
-     * 文本X方向的, 偏移量
-     * @description 文本X方向的, 偏移量, 支持正负
-     * @default 0
-     * @example offsetX: -10
+     * @description (水平)标注线整体在X方向的偏移像素距离, 一般情况下, 无需设置
+     * 负值则整体向左偏移, 例如设置为-10, 则整个(水平)标注线组件包括文本、箭头、线段, 一起向左偏移10像素
+     * 正值则整体向右偏移, 例如设置为10, 则整个(水平)标注线组件包括文本、箭头、线段, 一起向右偏移10像素
+     * @example offsetX: 0
      */
     offsetX?: number;
     /**
      * 线可见
      * @description 线可见
-     * @default true
      * @example true
      */
     lineVisible?: boolean;
     /**
-     * 线颜色
      * @description 线颜色
-     * @default 'red'
      * @example 'red'
      */
     lineColor?: string;
     /**
-     * 线宽度
      * @description 线宽度
-     * @default 2
      * @example 2
      */
     lineWidth?: number;
     /**
-     * 线样式
      * @description 线样式
-     * @default 'solid'
      * @example 'solid'
      */
     lineStyle?: 'solid' | 'dashed' | 'dotted';
     /**
-     * 背景可见
      * @description 背景可见
-     * @default true
      * @example true
      */
     backgroundVisible?: boolean;
     /**
-     * 背景颜色
      * @description 背景颜色
-     * @default '#212121'
      * @example 'red'
      */
     backgroundColor?: string;
     /**
-     * 背景边框颜色
      * @description 背景边框颜色
-     * @default 'red'
      * @example 'red'
      */
     backgroundBorderColor?: string;
     /**
      * 背景边框宽度
      * @description 背景边框宽度
-     * @default 1
      * @example 2
      */
     backgroundBorderWidth?: number;
     /**
-     * 背景边框圆角
      * @description 背景边框圆角
-     * @default 4
      * @example 4
      */
     backgroundBorderRadius?: number;
     /**
-     * 背景内边距
      * @description 背景内边距
-     * @default 4
      * @example 4
      */
     backgroundPadding?: number;
@@ -248,4 +227,6 @@ export declare const zAnnotationHorizontalLine: z.ZodObject<{
     backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
     backgroundBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
     backgroundPadding: z.ZodOptional<z.ZodNumber>;
+    offsetX: z.ZodDefault<z.ZodNumber>;
+    offsetY: z.ZodDefault<z.ZodNumber>;
 }, z.core.$strip>;

package/dist/types/properties/annotation/annotationPoint.d.ts

@@ -15,91 +15,77 @@ export type AnnotationPoint = {
     /**
      * 文本颜色
      * @description 文本颜色
-     * @default '#ffffff'
      * @example 'red'
      */
     textColor?: string;
     /**
      * 文本字体大小
      * @description 文本字体大小
-     * @default 12
      * @example 12
      */
     textFontSize?: number;
     /**
      * 文本字体重量
      * @description 文本字体重量
-     * @default 400
      * @example 400
      */
     textFontWeight?: number;
     /**
      * 文本对齐方式
      * @description 文本对齐方式
-     * @default 'left'
      * @example 'left'
      */
     textAlign?: 'left' | 'right' | 'center';
     /**
      * 文本垂直对齐方式
      * @description 文本垂直对齐方式
-     * @default 'middle'
      * @example 'middle'
      */
     textBaseline?: 'top' | 'middle' | 'bottom';
     /**
      * 文本Y方向的, 偏移量
-     * @description 文本Y方向的, 偏移量, 支持正负
-     * @default 0
      * @example offsetY: 10
      */
     offsetY?: number;
     /**
      * 文本X方向的, 偏移量
      * @description 文本X方向的, 偏移量, 支持正负
-     * @default 0
      * @example offsetX: -10
      */
     offsetX?: number;
     /**
      * 背景可见
      * @description 背景可见
-     * @default true
      * @example true
      */
     backgroundVisible?: boolean;
     /**
      * 背景颜色
      * @description 背景颜色
-     * @default '#212121'
      * @example 'red'
      */
     backgroundColor?: string;
     /**
      * 背景边框颜色
      * @description 背景边框颜色
-     * @default 'red'
      * @example 'red'
      */
     backgroundBorderColor?: string;
     /**
      * 背景边框宽度
      * @description 背景边框宽度
-     * @default 1
      * @example 2
      */
     backgroundBorderWidth?: number;
     /**
      * 背景边框圆角
      * @description 背景边框圆角
-     * @default 4
      * @example 4
      */
     backgroundBorderRadius?: number;
     /**
      * 背景内边距
      * @description 背景内边距
-     * @default 4
      * @example 4
      */
     backgroundPadding?: number;

package/dist/types/properties/annotation/annotationVerticalLine.d.ts

@@ -1,146 +1,122 @@
 import { type Selector, type Selectors } from '../../dataSelector';
 import { z } from 'zod';
+/**
+ * @description 垂直标注线, 根据用户设置的selector 或 xValue, 从下向上绘制一条末尾有箭头的线, 标签默认在标注线终点的正左侧
+ */
 export type AnnotationVerticalLine = {
     /**
-     * 依赖选择的数据, 进行数据标记.
+     * @description 依赖选择的数据, 进行数据标记.
      */
     selector?: Selector | Selectors;
     /**
-     * 固定的x值, 用于标注垂直线
-     * @description 类目轴在x方向, 则可输入维值, 数值轴在x方向, 则可输入具体的数值
-     * @default []
+     * @description 固定的x值, 用于标注垂直线, 类目轴在x方向, 则可输入维值, 数值轴在x方向, 则可输入具体的数值
      */
     xValue?: (number | string) | (number | string)[];
     /**
-     * 标注的文本
      * @description 标注的文本
      * @default ''
      * @example '标注文本'
      */
     text?: string | string[];
     /**
-     * 文本位置
-     * @description 标注线的标签位置（标签相对线的相对位置）。
-     * @default 'insideEnd'
+     * @description 文本位置, 标注线的标签位置（标签相对线的相对位置）。
      * @example 'outsideEnd'
      */
     textPosition?: 'outsideStart' | 'outsideEnd' | 'outsideMiddle' | 'insideStart' | 'insideMiddle' | 'insideEnd';
     /**
-     * 文本颜色
      * @description 文本颜色
-     * @default '#ffffff'
      * @example 'red'
      */
     textColor?: string;
     /**
-     * 文本字体大小
      * @description 文本字体大小
-     * @default 12
      * @example 12
      */
     textFontSize?: number;
     /**
-     * 文本字体重量
      * @description 文本字体重量
-     * @default 400
      * @example 400
      */
     textFontWeight?: number;
     /**
-     * 文本对齐方式
-     * @description 文本对齐方式
-     * @default 'right'
-     * @example 'left'
+     * @description 文本对齐方式, 一般情况下, 无需设置
+     * 建议设置为'right', 这样可以确保文本在标注线的左侧
+     * right: 文本在参考线的左侧, 文本的右侧边缘对齐(垂直)标注线
+     * left: 文本在参考线的右侧, 文本的左侧边缘对齐(垂直)标注线
+     * center: 文本在参考线的中心, 文本的中心对齐(垂直)标注线
+     * @example 'right'
      */
     textAlign?: 'left' | 'right' | 'center';
     /**
-     * 文本垂直对齐方式
-     * @description 文本垂直对齐方式
-     * @default 'top'
-     * @example 'middle'
+     * @description 文本垂直对齐方式, 一般情况下, 无需设置
+     * 建议设置为'top', 这样可以确保文本完整的显示在图表的可见区域
+     * top: 文本在参考线的底部, 文本的顶部边缘对齐(垂直)标注线的终点
+     * middle: 文本在参考线的中心, 文本的中心对齐(垂直)标注线的终点
+     * bottom: 文本在参考线的顶部, 文本的底部边缘对齐(垂直)标注线的终点
+     * @example 'top'
      */
     textBaseline?: 'top' | 'middle' | 'bottom';
     /**
-     * 文本Y方向的, 偏移量
-     * @description 文本Y方向的, 偏移量, 支持正负
-     * @default 0
-     * @example offsetY: 10
+     * @description (垂直)标注线整体在Y方向的偏移像素距离, 一般情况下, 无需设置
+     * 负值则整体向上偏移, 例如设置为-10, 则整个标注线组件包括文本、箭头、线段, 一起向上偏移10像素
+     * 正值则整体向下偏移, 例如设置为10, 则整个标注线组件包括文本、箭头、线段, 一起向下偏移10像素
+     * @example offsetY: 0
      */
     offsetY?: number;
     /**
-     * 文本X方向的, 偏移量
-     * @description 文本X方向的, 偏移量, 支持正负
-     * @default 0
-     * @example offsetX: -10
+     * @description (垂直)标注线整体在X方向的偏移像素距离, 一般情况下, 无需设置
+     * 负值则整体向左偏移, 例如设置为-10, 则整个标注线组件包括文本、箭头、线段, 一起向左偏移10像素
+     * 正值则整体向右偏移, 例如设置为10, 则整个标注线组件包括文本、箭头、线段, 一起向右偏移10像素
+     * @example offsetX: 0
      */
     offsetX?: number;
     /**
-     * 线可见
      * @description 线可见
-     * @default true
      * @example true
      */
     lineVisible?: boolean;
     /**
-     * 线颜色
      * @description 线颜色
-     * @default 'red'
      * @example 'red'
      */
     lineColor?: string;
     /**
-     * 线宽度
      * @description 线宽度
-     * @default 2
      * @example 2
      */
     lineWidth?: number;
     /**
-     * 线样式
      * @description 线样式
-     * @default 'solid'
      * @example 'solid'
      */
     lineStyle?: 'solid' | 'dashed' | 'dotted';
     /**
-     * 背景可见
      * @description 背景可见
-     * @default true
      * @example true
      */
     backgroundVisible?: boolean;
     /**
-     * 背景颜色
      * @description 背景颜色
-     * @default '#212121'
      * @example 'red'
      */
     backgroundColor?: string;
     /**
-     * 背景边框颜色
      * @description 背景边框颜色
-     * @default 'red'
      * @example 'red'
      */
     backgroundBorderColor?: string;
     /**
-     * 背景边框宽度
      * @description 背景边框宽度
-     * @default 1
      * @example 2
      */
     backgroundBorderWidth?: number;
     /**
-     * 背景边框圆角
      * @description 背景边框圆角
-     * @default 4
      * @example 4
      */
     backgroundBorderRadius?: number;
     /**
-     * 背景内边距
      * @description 背景内边距
-     * @default 4
      * @example 4
      */
     backgroundPadding?: number;
@@ -248,4 +224,6 @@ export declare const zAnnotationVerticalLine: z.ZodObject<{
     backgroundBorderWidth: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
     backgroundBorderRadius: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
     backgroundPadding: z.ZodOptional<z.ZodNumber>;
+    offsetX: z.ZodDefault<z.ZodNumber>;
+    offsetY: z.ZodDefault<z.ZodNumber>;
 }, z.core.$strip>;

package/dist/types/properties/config/axes/axis.d.ts

@@ -86,7 +86,7 @@ export type Axis = {
     /**
      * 轴标签, 自动限制长度的最大长度
      * @description 当标签文本长度超过最大长度时, 超出部分省略号表示, 鼠标悬浮后可见标签. 仅对类目轴生效.
-     * @default 100
+     * @default 80
      */
     labelAutoLimitLength?: number;
     /**

package/dist/types/properties/config/legend/legend.d.ts

@@ -12,15 +12,6 @@ export type Legend = {
      * @example border: true
      */
     border?: boolean;
-    /**
-     * 图例最大列数 或 图例最大行数
-     * @default 1
-     * @description
-     *  如果图例在水平方向上, maxSize控制显示的列数
-     *  如果图例在垂直方向上, maxSize控制显示的行数
-     * @example maxSize: 2
-     */
-    maxSize?: number;
     /**
      * 图例字体大小
      * @default 12
@@ -47,10 +38,18 @@ export type Legend = {
     shapeType?: 'circle' | 'cross' | 'diamond' | 'square' | 'arrow' | 'arrow2Left' | 'arrow2Right' | 'wedge' | 'thinTriangle' | 'triangle' | 'triangleUp' | 'triangleDown' | 'triangleRight' | 'triangleLeft' | 'stroke' | 'star' | 'wye' | 'rect' | 'arrowLeft' | 'arrowRight' | 'rectRound' | 'roundLine';
     /**
      * 图例位置
-     * @default 'top'
+     * @default 'right'
      * @example position: 'rightTop'
      */
     position?: 'left' | 'leftTop' | 'leftBottom' | 'lt' | 'lb' | 'top' | 'topLeft' | 'topRight' | 'tl' | 'tr' | 'right' | 'rightTop' | 'rightBottom' | 'rt' | 'rb' | 'bottom' | 'bottomLeft' | 'bottomRight' | 'bl' | 'br';
+    /**
+     * @description 存在大量图例时, 最大列数 或 图例最大行数
+     *  如果position为水平方向(bottom, bottomLeft, bottomRight, bl, br, top, topLeft, topRight, tl, tr), maxSize控制显示的列数
+     *  如果position为垂直方向(left, leftTop, leftBottom, lt, lb, right, rightTop, rightBottom, rt, rb), maxSize控制显示的行数
+     * @example maxSize: 2
+     * @default 1
+     */
+    maxSize?: number;
 };
 export declare const zLegend: z.ZodObject<{
     enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;

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

@@ -11,7 +11,12 @@ export type Measure = {
      */
     alias?: string;
     /**
-     * @description 是否自动格式化
+     * @description 自动数值格式化
+     * 开启后, 图表的数据标签、提示信息, 会根据指标的数值, 自动根据语言环境, 选择合适的格式化方式
+     * 格式化规则为设置为十进制数值, 开启compact notation, 最小0位小数, 最大2位小数, 自动四舍五入, 使用浏览器提供的 Intl.NumberFormatOptions 实现该逻辑.
+     * 例如:
+     * 当locale为zh-CN: 749740.264会被自动格式化为74.45万
+     * 当locale为en-US: 749740.264会被自动格式化为744.5K
      * @default true
      */
     autoFormat?: boolean;