vislite 1.9.0 → 1.10.0

package/types/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * VISLite 主类型定义文件
+ * 包含所有核心组件的类型定义
+ */
+
 /// <reference path="./uni-canvas.d.ts" />
 /// <reference path="./module.d.ts" />
 
@@ -42,7 +47,7 @@ import BarLayoutType from './BarLayout'
 
 import { initOptionType, mergeOptionType } from './option'
 
-// 插值
+// 插值构造函数类型
 interface NewCardinalType extends CardinalType {
     new(t?: number): CardinalType
 }
@@ -50,12 +55,12 @@ interface NewHermiteType extends HermiteType {
     new(u?: number): HermiteType
 }
 
-// 变换
+// 变换构造函数类型
 interface NewMatrix4Type extends Matrix4Type {
     new(initMatrix4?: number[]): Matrix4Type
 }
 
-// 画笔
+// 画笔构造函数类型
 interface NewSVGType extends SVGType {
     new(el: HTMLElement | null): SVGType
 }
@@ -66,7 +71,7 @@ interface NewRawCanvasType extends CanvasType {
     new(canvas: any, region?: any, scaleSize?: number): CanvasType
 }
 
-// WebGL
+// WebGL构造函数类型
 interface NewShaderType extends ShaderType {
     new(painter: WebGLRenderingContext): ShaderType
 }
@@ -77,7 +82,7 @@ interface NewTextureType extends TextureType {
     new(painter: WebGLRenderingContext, type: string, unit?: number): TextureType
 }
 
-// 投影
+// 投影构造函数类型
 interface NewEoapType extends MapType {
     new(scale?: number, center?: number[]): MapType
 }
@@ -85,12 +90,12 @@ interface NewMercatorType extends MapType {
     new(scale?: number, center?: number[]): MapType
 }
 
-// 坐标系
+// 坐标系构造函数类型
 interface NewMapCoordinateType extends MapCoordinateType {
     new(config?: MapConfigType): MapCoordinateType
 }
 
-// 布局
+// 布局构造函数类型
 interface NewTreeLayoutType extends TreeLayoutType {
     new(config?: TreeConfigType): TreeLayoutType
 }
@@ -101,97 +106,117 @@ interface NewBarLayoutType extends BarLayoutType {
     new(config?: BarConfigType): BarLayoutType
 }
 
+/**
+ * VISLite 主类
+ * 提供所有核心功能的静态访问入口
+ */
 export default class VISLite {
 
-    // 插值
+    /** Cardinal插值函数 */
     static Cardinal: NewCardinalType
+    /** Hermite插值函数 */
     static Hermite: NewHermiteType
 
-    // 变换
+    /** 4x4矩阵变换 */
     static Matrix4: NewMatrix4Type
+    /** 旋转变换函数 */
     static rotate: rotateType
+    /** 平移变换函数 */
     static move: moveType
+    /** 缩放变换函数 */
     static scale: scaleType
 
-    // 工具
+    /** 循环颜色获取函数 */
     static getLoopColors: getLoopColorsType
+    /** 动画函数 */
     static animation: animationType
+    /** 刻度尺计算函数 */
     static ruler: rulerType
 
-    // 画笔
+    /** SVG绘图类 */
     static SVG: NewSVGType
+    /** Canvas绘图类 */
     static Canvas: NewCanvasType
+    /** 原始Canvas绘图类 */
     static RawCanvas: NewRawCanvasType
 
-    // WebGL
+    /** WebGL上下文获取函数 */
     static getWebGLContext: getWebGLContextType
+    /** WebGL着色器类 */
     static Shader: NewShaderType
+    /** WebGL缓冲区类 */
     static Buffer: NewBufferType
+    /** WebGL纹理类 */
     static Texture: NewTextureType
 
-    // 投影
+    /** Eoap投影类 */
     static Eoap: NewEoapType
+    /** Mercator投影类 */
     static Mercator: NewMercatorType
 
-    // 辅助
+    /** 节流函数 */
     static throttle: throttleType
+    /** 数据组装函数 */
     static assemble: assembleType
 
-    // 坐标系
+    /** 地图坐标系类 */
     static MapCoordinate: NewMapCoordinateType
 
-    // 布局
+    /** 树形布局类 */
     static TreeLayout: NewTreeLayoutType
+    /** 饼图布局类 */
     static PieLayout: NewPieLayoutType
+    /** 柱状图布局类 */
     static BarLayout: NewBarLayoutType
 
-    // 配置项
+    /** 配置项初始化函数 */
     static initOption: initOptionType
+    /** 配置项合并函数 */
     static mergeOption: mergeOptionType
 }
 
-// 插值
+// 插值函数导出
 export let Cardinal: NewCardinalType
 export let Hermite: NewHermiteType
 
-// 变换
+// 变换函数导出
 export let Matrix4: NewMatrix4Type
 export let rotate: rotateType
 export let move: moveType
 export let scale: scaleType
 
-// 工具
+// 工具函数导出
 export let getLoopColors: getLoopColorsType
 export let animation: animationType
 export let ruler: rulerType
 
-// 画笔
+// 画笔类导出
 export let SVG: NewSVGType
 export let Canvas: NewCanvasType
 export let RawCanvas: NewRawCanvasType
 
-// WebGL
+// WebGL相关导出
 export let getWebGLContext: getWebGLContextType
 export let Shader: NewShaderType
 export let Buffer: NewBufferType
 export let Texture: NewTextureType
 
-// 投影
+// 投影类导出
 export let Eoap: NewEoapType
 export let Mercator: NewMercatorType
 
-// 辅助
+// 辅助函数导出
 export let throttle: throttleType
 export let assemble: assembleType
 
-// 坐标系
+// 坐标系类导出
 export let MapCoordinate: NewMapCoordinateType
 
-// 布局
+// 布局类导出
 export let TreeLayout: NewTreeLayoutType
 export let PieLayout: NewPieLayoutType
 export let BarLayout: NewBarLayoutType
 
-// 配置项
+// 配置项函数导出
 export let initOption: initOptionType
 export let mergeOption: mergeOptionType

package/types/move.d.ts

@@ -1,6 +1,16 @@
 /**
- * 移动
+ * 平移变换函数类型定义
+ * 用于计算二维坐标系中的平移变换
  */
 export default interface moveType {
+    /**
+     * 计算平移后的坐标
+     * @param ax 平移向量的x分量
+     * @param ay 平移向量的y分量
+     * @param d 平移距离
+     * @param x 原始点的x坐标
+     * @param y 原始点的y坐标
+     * @returns 返回平移后的坐标 [newX, newY]
+     */
     (ax: number, ay: number, d: number, x: number, y: number): [number, number]
 }

package/types/painterConfig.d.ts

@@ -1,5 +1,15 @@
+/**
+ * 绘图配置相关类型定义
+ * 定义了绘图相关的枚举类型
+ */
+
+/** 圆弧端点类型 */
 export type arcCapType = "butt" | "round" | "-round"
+/** 文字水平对齐方式 */
 export type textAlignType = "left" | "center" | "right"
+/** 文字垂直对齐方式 */
 export type textBaselineType = "top" | "middle" | "bottom"
+/** 线条端点类型 */
 export type lineCapType = "butt" | "round" | "square"
+/** 线条连接方式 */
 export type lineJoinType = "miter" | "bevel" | "round"

package/types/rotate.d.ts

@@ -1,6 +1,16 @@
 /**
- * 旋转
+ * 旋转变换函数类型定义
+ * 用于计算二维坐标系中的旋转变换
  */
 export default interface rotateType {
+    /**
+     * 计算旋转后的坐标
+     * @param cx 旋转中心的x坐标
+     * @param cy 旋转中心的y坐标
+     * @param deg 旋转角度（度）
+     * @param x 原始点的x坐标
+     * @param y 原始点的y坐标
+     * @returns 返回旋转后的坐标 [newX, newY]
+     */
     (cx: number, cy: number, deg: number, x: number, y: number): [number, number]
 }

package/types/ruler.d.ts

@@ -1,11 +1,25 @@
+/**
+ * 刻度尺配置选项类型定义
+ */
 export interface rulerOptionType {
+    /** 最大值限制 */
     max?: number
+    /** 最小值限制 */
     min?: number
 }
 
 /**
- * 刻度尺刻度运算，返回一个数组，表示刻度尺上应该显示的刻度
+ * 刻度尺计算函数类型定义
+ * 用于在给定范围内生成均匀的刻度值
  */
 export default interface rulerType {
+    /**
+     * 生成刻度值数组
+     * @param maxValue 数据最大值
+     * @param minValue 数据最小值
+     * @param num 期望的刻度数量
+     * @param option 可选的配置选项
+     * @returns 返回计算得到的刻度值数组
+     */
     (maxValue: number, minValue: number, num: number, option?: rulerOptionType): number[]
 }

package/types/scale.d.ts

@@ -1,6 +1,16 @@
 /**
- * 缩放
+ * 缩放变换函数类型定义
+ * 用于计算二维坐标系中的缩放变换
  */
 export default interface scaleType {
+    /**
+     * 计算缩放后的坐标
+     * @param cx 缩放中心的x坐标
+     * @param cy 缩放中心的y坐标
+     * @param times 缩放倍数
+     * @param x 原始点的x坐标
+     * @param y 原始点的y坐标
+     * @returns 返回缩放后的坐标 [newX, newY]
+     */
     (cx: number, cy: number, times: number, x: number, y: number): [number, number]
 }

package/types/throttle.d.ts

@@ -1,6 +1,7 @@
 import { throttleType } from "oipage/web/throttle/index"
 
 /**
- * 节流函数
+ * 节流函数类型定义
+ * 用于限制函数的执行频率，优化性能
  */
 export default throttleType

package/uni-app/ui-canvas.vue

@@ -131,9 +131,9 @@ export default {
       regionid = "region";
       // #endif
       // #ifndef MP-WEIXIN
-      painter = uni.createCanvasContext("painter-" + this.uniqueid, this);
+      painter = uni.createCanvasContext("painter-" + this.uniqueid);
       if (this.region)
-        region = uni.createCanvasContext("region-" + this.uniqueid, this);
+        region = uni.createCanvasContext("region-" + this.uniqueid);
       painterid = "painter-" + this.uniqueid;
       regionid = "region-" + this.uniqueid;
       // #endif