Merge pull request #333 from VisActor/release/0.11.0

[Auto release] release 0.11.0
VisActor · Sep 14, 2023 · 20b9ca2 · 20b9ca2
2 parents b7512e9 + 7ab1d98
commit 20b9ca2
Show file tree

Hide file tree

Showing 530 changed files with 240,145 additions and 1,725 deletions.
diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml
diff --git a/docs/assets/api/en/event/event.md b/docs/assets/api/en/event/event.md
@@ -313,6 +313,15 @@ Legend item hover to unhover events. **Legend exclusive event**
 
 The parameter type of the event callback function:
 
+```
+   { model: any; value: any; event: PointerEvent };
+```
+## LEGEND_CHANGE
+
+Color legend, size legend, this event is triggered after the user operates the legend range. **Legend exclusive event**
+
+Parameter types of event callback function:
+
 ```
    { model: any; value: any; event: PointerEvent };
 ```

diff --git a/docs/assets/api/en/methods.md b/docs/assets/api/en/methods.md
@@ -30,7 +30,7 @@ use:
 ```
 tableInstance.updateTheme(newTheme)
 ```
-Corresponding attribute update interface（https://visactor.io/vtable/tutorials/basic_function/update_option）:
+Corresponding attribute update interface（https://visactor.io/vtable/guide/basic_function/update_option）:
 ```
 // will not automatically redraw after calling
 tableInstance.theme = newTheme;
@@ -50,7 +50,7 @@ use:
 ```
 tableInstance. updateColumns(newColumns)
 ```
-Corresponding attribute update interface（https://visactor.io/vtable/tutorials/basic_function/update_option）:
+Corresponding attribute update interface（https://visactor.io/vtable/guide/basic_function/update_option）:
 ```
 // will not automatically redraw after calling
 tableInstance.columns = newColumns;
@@ -116,6 +116,31 @@ Listen to VChart chart events
 
 Unlisten to VChart chart events
 
+## selectCell(Function)
+
+Select a cell
+
+```
+  /**
+   * The effect of selecting a cell is the same as that of a cell selected by the mouse.
+   * @param col
+   * @param row
+   */
+  selectCell(col: number, row: number): void
+```
+
+## selectCells(Function)
+
+Select one or more cell ranges
+
+```
+  /**
+   * Select a cell area, and you can set multiple areas to be selected at the same time
+   * @param cellRanges: CellRange[]
+   */
+  selectCells(cellRanges: CellRange[]): void
+```
+
 ## getCellStyle(Function)
 
 Getting the style of a cell
@@ -375,3 +400,39 @@ Get the position of a certain primitive on the chart
    */
   getChartDatumPosition(datum:any,cellHeaderPaths:IPivotTableCellHeaderPaths):{x:number,y:number}
 ```
+
+## exportImg(Function)
+
+Export a picture of the currently visible area in the table.
+
+```
+  /**
+   * Export pictures of the currently visible area in the table
+   * @returns base64 picture
+   */
+  exportImg(): string
+```
+
+## exportCellImg(Function)
+
+Export a cell picture
+
+```
+ /**
+   * Export a cell picture
+   * @returns base64 picture
+   */
+  exportCellImg(col: number, row: number): string
+```
+
+## exportCellRangeImg(Function)
+
+Export a picture of a certain cell range
+
+```
+ /**
+   * Export pictures of a certain area
+   * @returns base64 picture
+   */
+  exportCellRangeImg(cellRange: CellRange): string
+```
diff --git a/docs/assets/api/en/register.md b/docs/assets/api/en/register.md
@@ -6,7 +6,7 @@ The features that can be globally registered in the table library are theme, ico
 
 ## theme(Function)
 
-[Usage example](/examples/theme/register):
+[Usage example](../demo/theme/register):
 
 - Register theme code as follows:
 
@@ -25,7 +25,7 @@ VTable.register.theme('themeRegisterOne',{
 function theme(name: string, theme?: ITableThemeDefine){}
 ```
 
-The structure of ITableThemeDefine can be found in [theme](/options/ListTable#theme)
+The structure of ITableThemeDefine can be found in [theme](../option/ListTable#theme)
 
 - Usage:
 
@@ -43,7 +43,7 @@ const tableInstance = new VTable.PivotTable({
 
 By registering icons, you can display icons in the table or replace built-in function icons such as pin freeze icon.
 
-[Usage example](/examples/custom-render/custom-icon):
+[Usage example](../demo/custom-render/custom-icon):
 
 - Register icon code as follows:
 
@@ -92,7 +92,7 @@ const tableInstance = new VTable.PivotTable({
 });
 ```
 
-2. After registering the icon, you can use it in customLayout. Refer to the [example](/examples/custom-render/custom-cell-layout).
+2. After registering the icon, you can use it in customLayout. Refer to the [example](../demo/custom-render/custom-cell-layout).
 
 - ColumnIconOption definition:
 
@@ -101,14 +101,20 @@ type ColumnIconOption = ImageIcon | SvgIcon;
 ```
 
 ###ImageIcon(Object)
+
+register image resource.
+
 {{ use: image-icon(  prefix = '####') }}
 
 ###SvgIcon(Object)
+
+register svg resource.
+
 {{ use: svg-icon(  prefix = '####') }}
 
 ## chartModule(Function)
 
-[Usage example](/examples/cell-type/chart):
+[Usage example](../demo/cell-type/chart):
 
 - Register chartModule code as follows:
 

diff --git a/docs/assets/api/zh/event/event.md b/docs/assets/api/zh/event/event.md
@@ -342,6 +342,15 @@ icon 图标点击事件。
    { model: any; value: any; event: PointerEvent };
 ```
 
+## LEGEND_CHANGE
+
+颜色图例，尺寸图例，用户操作图例范围后触发该事件。**图例专有事件**
+
+事件回调函数的参数类型:
+
+```
+   { model: any; value: any; event: PointerEvent };
+```
 ## MOUSEENTER_AXIS
 
 鼠标进入到坐标轴上事件。**坐标轴专有事件**

diff --git a/docs/assets/api/zh/methods.md b/docs/assets/api/zh/methods.md
@@ -30,7 +30,7 @@
 ```
 tableInstance.updateTheme(newTheme)
 ```
-对应属性更新接口（可参考教程：https://visactor.io/vtable/tutorials/basic_function/update_option）:
+对应属性更新接口（可参考教程：https://visactor.io/vtable/guide/basic_function/update_option）:
 ```
 // 调用后不会自动重绘
 tableInstance.theme = newTheme;
@@ -50,7 +50,7 @@ tableInstance.theme = newTheme;
 ```
 tableInstance.updateColumns(newColumns)
 ```
-对应属性更新接口（可参考教程：https://visactor.io/vtable/tutorials/basic_function/update_option）:
+对应属性更新接口（可参考教程：https://visactor.io/vtable/guide/basic_function/update_option）:
 ```
 // 调用后不会自动重绘
 tableInstance.columns = newColumns;
@@ -114,6 +114,30 @@ tableInstance.renderWithRecreateCells();
 ## offVChartEvent(Function)
 
 解除监听 VChart 图表事件
+## selectCell(Function)
+
+选中某个单元格
+
+```
+  /**
+   * 选中单元格  和鼠标选中单元格效果一致
+   * @param col
+   * @param row
+   */
+  selectCell(col: number, row: number): void
+```
+
+## selectCells(Function)
+
+选中一个或者多个单元格区域
+
+```
+  /**
+   * 选中单元格区域，可设置多个区域同时选中
+   * @param cellRanges: CellRange[]
+   */
+  selectCells(cellRanges: CellRange[]): void
+```
 
 ## getCellStyle(Function)
 
@@ -247,7 +271,8 @@ tableInstance.renderWithRecreateCells();
 
 ## scrollToCell(Function)
 
-滚动到具体某个单元格位置
+滚动到具体某个单元格位置。
+col或者row可以为空，为空的话也就是只移动x方向或者y方向。
 
 ```
   /**
@@ -372,5 +397,41 @@ use case: 点击图例项后 更新过滤规则 来更新图表
    * @param cellHeaderPaths 单元格的header路径
    * @returns 图元在整个表格上的坐标位置（相对表格左上角视觉坐标）
    */
-  getChartDatumPosition(datum:any,cellHeaderPaths:IPivotTableCellHeaderPaths):{x:number,y:number}
+  getChartDatumPosition(datum:any,cellHeaderPaths:IPivotTableCellHeaderPaths): {x:number,y:number}
 ```
+
+## exportImg(Function)
+
+导出表格中当前可视区域的图片。
+
+```
+  /**
+   * 导出表格中当前可视区域的图片
+   * @returns base64图片
+   */
+  exportImg(): string
+```
+
+## exportCellImg(Function)
+
+导出某个单元格图片
+
+```
+ /**
+   * 导出某个单元格图片
+   * @returns base64图片
+   */
+  exportCellImg(col: number, row: number): string
+```
+
+## exportCellRangeImg(Function)
+
+导出某一片单元格区域的图片
+
+```
+ /**
+   * 导出某一片区域的图片
+   * @returns base64图片
+   */
+  exportCellRangeImg(cellRange: CellRange): string
+```
diff --git a/docs/assets/api/zh/register.md b/docs/assets/api/zh/register.md
@@ -6,7 +6,7 @@
 
 ## theme(Function)
 
-[使用示例](/examples/theme/register):
+[使用示例](../demo/theme/register):
 
 - 注册 theme 代码如下：
 
@@ -25,7 +25,7 @@ VTable.register.theme('themeRegisterOne',{
 function theme(name: string, theme?: ITableThemeDefine){}
 ```
 
-ITableThemeDefine 的结构可参考[theme](/options/ListTable#theme)
+ITableThemeDefine 的结构可参考[theme](../option/ListTable#theme)
 
 - 使用方式：
 
@@ -43,7 +43,7 @@ const tableInstance = new VTable.PivotTable({
 
 通过注册 icon 可以在表格中显示图标，或者替换内置的功能图标如 pin 冻结图标。
 
-[使用示例](/examples/custom-render/custom-icon)：
+[使用示例](../demo/custom-render/custom-icon)：
 
 - 注册 icon 代码如下：
 
@@ -92,7 +92,7 @@ const tableInstance = new VTable.PivotTable({
 });
 ```
 
-2. 注册好icon 之后在 customLayout 中使用可参考[示例](/examples/custom-render/custom-cell-layout)
+2. 注册好icon 之后在 customLayout 中使用可参考[示例](../demo/custom-render/custom-cell-layout)
 
 - ColumnIconOption 定义：
 
@@ -101,14 +101,20 @@ type ColumnIconOption = ImageIcon | SvgIcon;
 ```
 
 ###ImageIcon(Object)
+
+注册图片资源的icon
+
 {{ use: image-icon(  prefix = '####') }}
 
 ###SvgIcon(Object)
+
+注册svg资源的icon
+
 {{ use: svg-icon(  prefix = '####') }}
 
 ## chartModule(Function)
 
-[使用示例](/examples/cell-type/chart)：
+[使用示例](../demo/cell-type/chart)：
 
 - 注册 chartModule 代码如下：
 

diff --git a/.../en/basic-functionality/auto-wrap-text.md → .../en/basic-functionality/auto-wrap-text.md b/.../en/basic-functionality/auto-wrap-text.md → .../en/basic-functionality/auto-wrap-text.md
@@ -4,7 +4,7 @@ group: Basic Features
 title: Line Wrapping
 cover: https://lf9-dp-fe-cms-tos.byteorg.com/obj/bit-cloud/VTable/preview/auto-wrap-text.gif
 order: 3-1
-link: '/tutorials/basic_function/auto_wrap_text'
+link: '../guide/basic_function/auto_wrap_text'
 ---
 
 # line wrapping