docs: 合并单元格文档更新

antvis · Aug 3, 2022 · c3558a0 · c3558a0
1 parent 582bc91
commit c3558a0
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 14 deletions.
diff --git a/s2-site/docs/api/general/S2Options.zh.md b/s2-site/docs/api/general/S2Options.zh.md
@@ -182,8 +182,4 @@ DataSet = (spreadsheet: SpreadSheet) => BaseDataSet;
 
 ## MergedCellInfo
 
-| 参数            | 说明                 | 类型                   | 默认值 | 必选 |
-| --------------- | ------------------ | ---------------------- | ------ | ---- |
-| colIndex        | 单元格的列索引        | `number`               | -      |      |
-| rowIndex        | 单元格的行索引        | `number`               | -      |      |
-| showText        | 合并单元格是否展示当前单元格的 meta 信息，只需要对一个单元格进行标识，</br>若未对单元格进行标识，会默认使用第一个选中点击的单元格的 meta 信息 | `booelan`      | -      |      |
+`markdown:docs/common/merged-cell.zh.md`
diff --git a/s2-site/docs/common/merged-cell.en.md b/s2-site/docs/common/merged-cell.en.md
@@ -0,0 +1,5 @@
+---
+title: Merge-Cell
+order: 10
+---
+`markdown:docs/common/merge-cell.zh.md`
diff --git a/s2-site/docs/common/merged-cell.zh.md b/s2-site/docs/common/merged-cell.zh.md
@@ -0,0 +1,14 @@
+---
+title: 合并单元
+order: 10
+---
+
+<description> **optional**  _MergedCellInfo[][]_   default: `undefined` </description>
+
+设置默认合并的单元格信息
+
+| 参数            | 说明                                                                             | 类型                   | 默认值 | 必选 |
+| --------------- |--------------------------------------------------------------------------------| ---------------------- | ------ | ---- |
+| colIndex        | 单元格的列索引                                                                        | `number`               | -      |      |
+| rowIndex        | 单元格的行索引                                                                        | `number`               | -      |      |
+| showText        | 设置 `showText: true` 时，则展示当前格子的 `meta` 信息为合并后单元格的 `meta`。<br/> 默认使用第一个选中点击的单元格。 | `booelan`      | -      |      |
diff --git a/s2-site/docs/manual/advanced/interaction/merge-cell.zh.md b/s2-site/docs/manual/advanced/interaction/merge-cell.zh.md
@@ -343,17 +343,11 @@ s2.render();
 
 ## 配置和方法说明
 
-### mergedCellsInfo
+### MergedCellInfo
 
-<description> **optional**  _MergedCellInfo[][]_   default: `undefined` </description>
+`markdown:docs/common/merged-cell.zh.md`
 
-设置默认合并的单元格信息
-
-| 参数            | 说明                 | 类型                   | 默认值 | 必选 |
-| --------------- | ------------------ | ---------------------- | ------ | ---- |
-| colIndex        | 单元格的列索引        | `number`               | -      |      |
-| rowIndex        | 单元格的行索引        | `number`               | -      |      |
-| showText        | 合并单元格是否展示当前单元格的 meta 信息，只需要对一个单元格进行标识，</br>若未对单元格进行标识，会默认使用第一个选中点击的单元格的 meta 信息 | `booelan`      | -      |      |
+![合并单元格](https://gw.alipayobjects.com/zos/antfincdn/kHAYfFaJA/ae92e636-6574-487b-8d78-57dcae21e1d4.png)
 
 ### mergeCells