Skip to content

Commit e76b226

Browse files
lcx-seimalcx-seima
committed
docs: 其他分析组件区分react/vue章节
1 parent e6ea895 commit e76b226

File tree

5 files changed

+155
-126
lines changed

5 files changed

+155
-126
lines changed

‎s2-site/docs/api/components/advanced-sort.zh.md‎

Lines changed: 46 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -3,69 +3,75 @@ title: 高级排序
33
order: 4
44
---
55

6+
# React 高级排序组件
7+
68
## AdvancedSortProps
79

810
`AdvancedSort` 组件的 `props`
911

10-
| 参数 | 说明 | 类型 | 必选 | 默认值 |
11-
| :------------ | :--------------------------- | :----------------------------------------------------------- | :--- | :----- |
12-
| sheet | 当前表实例 | [SpreadSheet](https://s2.antv.vision/zh/docs/api/basic-class/spreadsheet) | ✓ | |
13-
| open | 是否展示 | `boolean` | ✓ | |
14-
| className | class类名称 | `string` | | |
15-
| icon | 排序按钮图标 | `React.ReactNode` | | |
16-
| text | 排序按钮名称 | `string` | | |
17-
| ruleText | 规则描述 | `string` | | |
18-
| dimensions | 可选字段列表 | [Dimension](#dimension)[] | | |
19-
| ruleOptions | 规则配置列表 | [RuleOption](#ruleoption)[] | | |
20-
| sortParams | 默认已有 sort 规则 | [SortParams](https://s2.antv.vision/zh/docs/api/general/S2DataConfig#sortparams) | | |
21-
| onSortOpen | 打开排序弹窗的回调 | `() => void` | | |
22-
| onSortConfirm | 关闭弹窗后处理排序结果的回调 | `(ruleValues:`[RuleValue](#rulevalue)[]`, sortParams:`[SortParams](https://s2.antv.vision/zh/docs/api/general/S2DataConfig#sortparams)`) => void` | | |
12+
| 参数 | 说明 | 类型 | 必选 | 默认值 |
13+
| :-- | :-- | :-- | :-- | :-- |
14+
| sheet | 当前表实例 | [SpreadSheet](https://s2.antv.vision/zh/docs/api/basic-class/spreadsheet) | ✓ | |
15+
| open | 是否展示 | `boolean` | ✓ | |
16+
| className | class 类名称 | `string` | | |
17+
| icon | 排序按钮图标 | `React.ReactNode` | | |
18+
| text | 排序按钮名称 | `string` | | |
19+
| ruleText | 规则描述 | `string` | | |
20+
| dimensions | 可选字段列表 | [Dimension](#dimension)[] | | |
21+
| ruleOptions | 规则配置列表 | [RuleOption](#ruleoption)[] | | |
22+
| sortParams | 默认已有 sort 规则 | [SortParams](https://s2.antv.vision/zh/docs/api/general/S2DataConfig#sortparams) | | |
23+
| onSortOpen | 打开排序弹窗的回调 | `() => void` | | |
24+
| onSortConfirm | 关闭弹窗后处理排序结果的回调 | `(ruleValues:`[RuleValue](#rulevalue)[]`, sortParams:`[SortParams](https://s2.antv.vision/zh/docs/api/general/S2DataConfig#sortparams)`) => void` | | |
2325

2426
## AdvancedSortCfgProps
2527

2628
在 `header` 中配置 `advancedSortCfg` 的 `props`
2729

28-
| 参数 | 说明 | 类型 | 必选 | 默认值 |
29-
| :------------ | :--------------------------- | :----------------------------------------------------------- | :--- | :----- |
30-
| open | 是否展示 | `boolean` | | false |
31-
| className | class类名称 | `string` | | |
32-
| icon | 排序按钮图标 | `React.ReactNode` | | |
33-
| text | 排序按钮名称 | `ReactNode` | | |
34-
| ruleText | 规则描述 | `string` | | |
35-
| dimensions | 可选字段列表 | [Dimension](#dimension)[] | | |
36-
| ruleOptions | 规则配置列表 | [RuleOption](#ruleoption)[] | | |
37-
| sortParams | 默认已有 sort 规则 | [SortParams](https://s2.antv.vision/zh/docs/api/general/S2DataConfig#sortparams) | | |
38-
| onSortOpen | 打开排序弹窗的回调 | `() => void` | | |
39-
| onSortConfirm | 关闭弹窗后处理排序结果的回调 | `(ruleValues:`[RuleValue](#rulevalue)[]`, sortParams:`[SortParams](https://s2.antv.vision/zh/docs/api/general/S2DataConfig#sortparams)`) => void` | | |
30+
| 参数 | 说明 | 类型 | 必选 | 默认值 |
31+
| :-- | :-- | :-- | :-- | :-- |
32+
| open | 是否展示 | `boolean` | | false |
33+
| className | class 类名称 | `string` | | |
34+
| icon | 排序按钮图标 | `React.ReactNode` | | |
35+
| text | 排序按钮名称 | `ReactNode` | | |
36+
| ruleText | 规则描述 | `string` | | |
37+
| dimensions | 可选字段列表 | [Dimension](#dimension)[] | | |
38+
| ruleOptions | 规则配置列表 | [RuleOption](#ruleoption)[] | | |
39+
| sortParams | 默认已有 sort 规则 | [SortParams](https://s2.antv.vision/zh/docs/api/general/S2DataConfig#sortparams) | | |
40+
| onSortOpen | 打开排序弹窗的回调 | `() => void` | | |
41+
| onSortConfirm | 关闭弹窗后处理排序结果的回调 | `(ruleValues:`[RuleValue](#rulevalue)[]`, sortParams:`[SortParams](https://s2.antv.vision/zh/docs/api/general/S2DataConfig#sortparams)`) => void` | | |
4042

4143
## Dimension
4244

4345
可选字段列表，不配置默认为：`行头+列头+数值`
4446

4547
| 参数 | 说明 | 类型 | 默认值 | 必选 |
4648
| :---- | :------- | :--------- | :----- | :--- |
47-
| field | 维度id | `string` | ✓ | |
48-
| name | 维度名称 | `string` | ✓ | |
49-
| list | 维度列表 | `string[]` | ✓ | |
49+
| field | 维度 id | `string` | ✓ | |
50+
| name | 维度名称 | `string` | ✓ | |
51+
| list | 维度列表 | `string[]` | ✓ | |
5052

5153
## RuleOption
5254

5355
规则配置列表，不配置默认为：`首字母、手动排序、其他字段`
5456

55-
| 参数 | 说明 | 类型 | 默认值 | 必选 |
56-
| :------- | :--------- | :------------------------------------------ | :----- | :--- |
57-
| label | 规则名称 | `string` | ✓ | |
58-
| value | 规则值 | `'sortMethod' | 'sortBy' | 'sortByMeasure'` | | ✓ |
59-
| children | 规则子列表 | `RuleOption[]` | ✓ | |
57+
| 参数 | 说明 | 类型 | 默认值 | 必选 |
58+
| :------- | :--------- | :------------- | :------- | :--------------- | --- | --- |
59+
| label | 规则名称 | `string` | ✓ | |
60+
| value | 规则值 | `'sortMethod' | 'sortBy' | 'sortByMeasure'` | | ✓ |
61+
| children | 规则子列表 | `RuleOption[]` | ✓ | |
6062

6163
## RuleValue
6264

6365
关闭弹窗后处理排序结果的回调函数的第一个参数：获取到的排序信息
6466

65-
| 参数 | 说明 | 类型 | 默认值 | 必选 |
66-
| :------------ | :------------------ | :--------------------------------- | :----- | :--- |
67-
| field | 维度id | `string` | ✓ | |
68-
| name | 维度名称 | `string` | ✓ | |
69-
| sortMethod | 排序方式（升/降序） | `ASC` \| `DESC` \| `asc` \| `desc` | | |
70-
| sortBy | 自定义排序列表 | `string[]` | | |
71-
| sortByMeasure | 类 | `string` | | |
67+
| 参数 | 说明 | 类型 | 默认值 | 必选 |
68+
| :-- | :-- | :-- | :-- | :-- |
69+
| field | 维度 id | `string` | ✓ | |
70+
| name | 维度名称 | `string` | ✓ | |
71+
| sortMethod | 排序方式（升/降序） | `ASC` \| `DESC` \| `asc` \| `desc` | | |
72+
| sortBy | 自定义排序列表 | `string[]` | | |
73+
| sortByMeasure | 类 | `string` | | |
74+
75+
# Vue 高级排序组件
76+
77+
开发中，敬请期待

‎s2-site/docs/api/components/drill-down.zh.md‎

Lines changed: 33 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,21 @@ title: 维度下钻
33
order: 2
44
---
55

6+
# React 下钻组件
7+
68
## PartDrillDown
79

810
类型：`object`，**可选**，默认值：`{}`
911

1012
<description>功能描述：配置维度下钻，当前仅支持树形模式下的行头维度下钻</description>
1113

12-
| 参数 | 说明 | 类型 | 默认值 | 必选 |
13-
| ---------- | ---------- | --------------- | ------ | ---- |
14+
| 参数 | 说明 | 类型 | 默认值 | 必选 |
15+
| --- | --- | --- | --- | --- |
1416
| drillConfig | 下钻菜单组件配置项 | [DrillDownProps](#drilldownprops) | - | ✓ |
15-
| drillItemsNum | 下钻完成后展示的个数，默认全部展示 | `number` | -1 | |
17+
| drillItemsNum | 下钻完成后展示的个数，默认全部展示 | `number` | -1 | |
1618
| fetchData | 点击下钻后的回调 | [FetchCallBack](#fetchcallback) | - | ✓ |
17-
| clearDrillDown | 清除下钻信息，当有指定的rowId 传递时清除对应rowId的下钻信息；如果参数是 空对象 {}，则清空所有的下钻信息 | `{rowId: string;}` | - | |
18-
| displayCondition | 配置下钻 `icon` 的展示条件， 同 HeaderActionIcon | `(meta: Node) => boolean` | - | |
19+
| clearDrillDown | 清除下钻信息，当有指定的 rowId 传递时清除对应 rowId 的下钻信息；如果参数是 空对象 {}，则清空所有的下钻信息 | `{rowId: string;}` | - | |
20+
| displayCondition | 配置下钻 `icon` 的展示条件， 同 HeaderActionIcon | `(meta: Node) => boolean` | - | |
1921

2022
注意：PartDrillDown 中 `drillConfig`、`displayCondition` 字段会影响下钻模式的重渲，请注意使用 memo 或 state 控制其可变性。
2123

@@ -25,49 +27,52 @@ order: 2
2527
(meta: Node, drillFields: string[]) => Promise<PartDrillDownInfo>
2628
```
2729

28-
功能描述：点击下钻后的回调
29-
参数：[PartDrillDownInfo](#partdrilldowninfo)
30+
功能描述：点击下钻后的回调参数：[PartDrillDownInfo](#partdrilldowninfo)
3031

3132
#### PartDrillDownInfo
3233

3334
类型：`object`，**必选**，默认值：`{}`
3435

3536
<description>功能描述：下钻数据请求参数配置</description>
3637

37-
| 参数 | 说明 | 类型 | 必选 | 默认值 |
38-
| --- | --- | --- |-------------------| --- |
39-
| drillData | 下钻的数据 | <code class="language-text">Record<string, string \| number>[] </code> | ✓ | |
40-
| drillField | 下钻维度 value 值 | `string` | ✓ | |
38+
| 参数 | 说明 | 类型 | 必选 | 默认值 |
39+
| --- | --- | --- | --- | --- |
40+
| drillData | 下钻的数据 | <code class="language-text">Record<string, string \| number>[] </code> | ✓ | |
41+
| drillField | 下钻维度 value 值 | `string` | ✓ | |
4142

4243
### DrillDownProps
4344

4445
类型：`object`，**必选**，默认值：`{}`
4546

4647
<description>功能描述：下钻菜单组件配置项</description>
4748

48-
| 参数 | 说明 | 类型 | 默认值 | 必选 |
49-
| ---------- | ---------- | --------------- | ------ | ---- |
49+
| 参数 | 说明 | 类型 | 默认值 | 必选 |
50+
| --- | --- | --- | --- | --- |
5051
| dataSet | 下钻数据源配置 | [DataSet[]](#dataset) | | ✓ |
51-
| className | 透传样式名 | `string` | | |
52-
| titleText | 标题 | `string` | | |
53-
| searchText | 搜索框文案 | `string` | | |
54-
| clearButtonText | 重置按钮文案 | `string` | | |
55-
| extra | 自定义插入的节点（插入在搜索框和下钻菜单中间） | `ReactNode` | | |
56-
| drillFields | 允许下钻的维度 | `string[]` | | |
57-
| disabledFields | 不允许下钻的维度| `string[]` | | |
58-
| getDrillFields | 内部获取当前下钻维度的回调 | `Function` | | |
59-
| setDrillFields | 内部设置当前下钻维度的回调 | `Function` | | |
52+
| className | 透传样式名 | `string` | | |
53+
| titleText | 标题 | `string` | | |
54+
| searchText | 搜索框文案 | `string` | | |
55+
| clearButtonText | 重置按钮文案 | `string` | | |
56+
| extra | 自定义插入的节点（插入在搜索框和下钻菜单中间） | `ReactNode` | | |
57+
| drillFields | 允许下钻的维度 | `string[]` | | |
58+
| disabledFields | 不允许下钻的维度 | `string[]` | | |
59+
| getDrillFields | 内部获取当前下钻维度的回调 | `Function` | | |
60+
| setDrillFields | 内部设置当前下钻维度的回调 | `Function` | | |
6061

6162
#### DataSet
6263

6364
类型：`object`，**必选**，默认值：`{}`
6465

6566
<description>功能描述：下钻数据源配置</description>
6667

67-
| 参数 | 说明 | 类型 | 默认值 | 必选 |
68-
| ---------- | ---------- | --------------- | ------ | ---- |
69-
| name | 展示名字 | `string` | | ✓ |
68+
| 参数 | 说明 | 类型 | 默认值 | 必选 |
69+
| --- | --- | --- | --- | --- |
70+
| name | 展示名字 | `string` | | ✓ |
7071
| value | 具体值 | `string` | | ✓ |
71-
| type | 维度类型, 不同类型对应 icon 不同 | `text` \| `location` \| `date` | | |
72-
| disabled | 是否允许选择 | `boolean` | | |
73-
| icon | 列表 item 的 icon | `React.ReactNode` | | |
72+
| type | 维度类型, 不同类型对应 icon 不同 | `text` \| `location` \| `date` | | |
73+
| disabled | 是否允许选择 | `boolean` | | |
74+
| icon | 列表 item 的 icon | `React.ReactNode` | | |
75+
76+
# Vue 下钻组件
77+
78+
开发中，敬请期待

‎s2-site/docs/api/components/export.zh.md‎

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: 导出
33
order: 5
44
---
55

6+
# React 导出组件
7+
68
```tsx
79
<SheetComponent
810
dataCfg={dataCfg}
@@ -13,18 +15,22 @@ order: 5
1315

1416
## ExportCfgProps
1517

16-
| 属性 | 说明 | 类型 | 默认值 | 必选 |
17-
| :------------------- | :----------------- | :---------- | :----- | :--- |
18-
| open | 开启组件 | `boolean` | `false` | ✓ |
19-
| className | 类名 | `string` | | |
20-
| icon | 展示图标 | `ReactNode` | | |
21-
| copyOriginalText | 复制原始数据文案 | `string` | | |
22-
| copyFormatText | 复制格式化数据文案 | `string` | | |
23-
| downloadOriginalText | 下载原始数据文案 | `string` | | |
24-
| downloadFormatText | 下载格式化数据文案 | `string` | | |
25-
| successText | 操作成功文案 | `string` | | |
26-
| errorText | 操作失败文案 | `string` | | |
27-
| fileName | 自定义下载文件名 | `string` | `sheet` | |
28-
| syncCopy | 同步复制数据 （默认异步） | `boolean` | `false` | |
18+
| 属性 | 说明 | 类型 | 默认值 | 必选 |
19+
| :-- | :-- | :-- | :-- | :-- |
20+
| open | 开启组件 | `boolean` | `false` | ✓ |
21+
| className | 类名 | `string` | | |
22+
| icon | 展示图标 | `ReactNode` | | |
23+
| copyOriginalText | 复制原始数据文案 | `string` | | |
24+
| copyFormatText | 复制格式化数据文案 | `string` | | |
25+
| downloadOriginalText | 下载原始数据文案 | `string` | | |
26+
| downloadFormatText | 下载格式化数据文案 | `string` | | |
27+
| successText | 操作成功文案 | `string` | | |
28+
| errorText | 操作失败文案 | `string` | | |
29+
| fileName | 自定义下载文件名 | `string` | `sheet` | |
30+
| syncCopy | 同步复制数据 （默认异步） | `boolean` | `false` | |
2931

3032
`markdown:docs/common/export.zh.md`
33+
34+
# Vue 导出组件
35+
36+
开发中，敬请期待

‎s2-site/docs/api/components/header.zh.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ title: 表头
33
order: 4
44
---
55

6-
> **optional** _HeaderCfgProps_ default: `{}`
6+
# React 表头组件
7+
8+
> **optional** _HeaderCfgProps_ default: `{}`
79
810
表格页头，位于表格容器顶部，起到了内容概览和表格工具栏的作用。由表标题、描述、导出、高级排序、指标切换和自定操作区组成。
911

@@ -19,7 +21,7 @@ order: 4
1921
exportCfg: { open: true }, // 开启导出功能
2022
advancedSortCfg: { open: true }, // 开启高级排序功能
2123
switcherCfg: { open: true }, // 开启指标切换功能
22-
extra: (<button> 插入内容 </button>), //自定义 ReactNode
24+
extra: <button> 插入内容 </button>, //自定义 ReactNode
2325
}}
2426
/>
2527
```
@@ -29,3 +31,7 @@ order: 4
2931
## API
3032

3133
`markdown:docs/common/header.zh.md`
34+
35+
# Vue 表头组件
36+
37+
开发中，敬请期待

0 commit comments

Comments
 (0)