docs: 文档完善

- 完善 getTransform 方法的相关文档
didi · Aug 11, 2024 · c93eff0 · c93eff0
1 parent 27c10a4
commit c93eff0
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/sites/docs/docs/api/detail/index.zh.md b/sites/docs/docs/api/detail/index.zh.md
@@ -1099,13 +1099,22 @@ lf.setZoomMaxSize(20);
 
 ### getTransform
 
-获取当前画布的放大缩小值。
+获取当前画布的缩放值与偏移值。
 
 ```tsx | pure
 const transform = lf.getTransform();
 console.log(transform);
 ```
 
+`getTransform` 方法返回的对象包含以下属性：
+
+| 属性 | 类型 | 值 |
+|:-----|:-------|:---|
+| SCALE_X | number | x 轴缩放比例 |
+| SCALE_Y | number | y 轴缩放比例 |
+| TRANSLATE_X | number | x 轴偏移值 |
+| TRANSLATE_Y | number | y 轴偏移值 |
+
 ### translate
 
 平移图

diff --git a/sites/docs/docs/api/index.zh.md b/sites/docs/docs/api/index.zh.md
@@ -113,7 +113,7 @@ table td:first-of-type {
 | [resetZoom](./detail/index.zh.md#resetzoom) | 重置图形的缩放比例为默认，默认是 1。 |
 | [setZoomMiniSize](./detail/index.zh.md#setzoomminisize) | 设置图形缩小时，能缩放到的最小倍数。参数一般为 0-1 之间，默认 0.2。 |
 | [setZoomMaxSize](./detail/index.zh.md#setzoommaxsize) | 设置图形放大时，能放大到的最大倍数，默认 16。 |
-| [getTransform](./detail/index.zh.md#gettransform) | 获取当前画布的放大缩小值。 |
+| [getTransform](./detail/index.zh.md#gettransform) | 获取当前画布的缩放值与偏移值。 |
 | [translate](./detail/index.zh.md#translate) | 平移图。 |
 | [resetTranslate](./detail/index.zh.md#resettranslate) | 还原图形为初始位置。 |
 | [translateCenter](./detail/index.zh.md#translatecenter) | 图形画布居中显示。 |