Files
xk-docs/docs/projects/xk-api/modules/spreadsheet.md
2026-07-08 15:04:42 +08:00

131 lines
3.6 KiB
Markdown

# 画布表格模块
## 概述
画布表格模块提供类似 Excel 的在线表格编辑功能,支持表格配置、编辑历史、公式库等。
---
## 表格配置
### 接口
| 方法 | 路径 | 说明 |
|------|------|------|
| GET | `spreadsheet-table-config/list` | 配置列表 |
| GET | `spreadsheet-table-config/detail` | 配置详情 |
| POST | `spreadsheet-table-config/create` | 创建配置 |
| POST | `spreadsheet-table-config/update` | 更新配置 |
| POST | `spreadsheet-table-config/delete` | 删除配置 |
### 关联类
| 类 | 文件 | 说明 |
|----|------|------|
| `SpreadsheetTableConfigController` | `app/Http/Controllers/admin/system/SpreadsheetTableConfigController.php` | 控制器 |
| `SpreadsheetTableConfigService` | `app/Service/admin/system/SpreadsheetTableConfigService.php` | 业务服务 |
### 关联模型
| 模型 | 表名 | 说明 |
|------|------|------|
| `SpreadsheetTableConfigModel` | `xk_spreadsheet_table_config` | 画布表格配置 |
### 字段说明
| 字段 | 类型 | 说明 |
|------|------|------|
| `admin_id` | bigint | 管理员 ID |
| `table_name` | varchar | 表名 |
| `sheet_key` | varchar | 工作表标识 |
| `name` | varchar | 配置名称 |
| `is_default` | tinyint | 是否默认配置 |
| `config` | json | 表格配置 |
---
## 编辑历史
### 接口
| 方法 | 路径 | 说明 |
|------|------|------|
| GET | `spreadsheet-history/list` | 历史列表 |
| POST | `spreadsheet-history/rollback` | 回滚操作 |
### 关联类
| 类 | 文件 | 说明 |
|----|------|------|
| `SpreadsheetHistoryController` | `app/Http/Controllers/admin/system/SpreadsheetHistoryController.php` | 控制器 |
| `SpreadsheetHistoryService` | `app/Service/admin/system/SpreadsheetHistoryService.php` | 业务服务 |
### 关联模型
| 模型 | 表名 | 说明 |
|------|------|------|
| `SpreadsheetEditHistoryModel` | `xk_spreadsheet_edit_history` | 画布编辑历史 |
### 操作类型
| 类型 | 说明 |
|------|------|
| edit | 编辑单元格 |
| fill | 填充 |
| paste | 粘贴 |
| rollback | 回滚 |
### 字段说明
| 字段 | 类型 | 说明 |
|------|------|------|
| `table_name` | varchar | 表名 |
| `sheet_key` | varchar | 工作表标识 |
| `admin_user_id` | bigint | 操作管理员 |
| `admin_user_name` | varchar | 管理员名称 |
| `row_key` | varchar | 行标识 |
| `field_id` | varchar | 字段 ID |
| `action` | varchar | 操作类型 |
| `before_snapshot` | json | 操作前快照 |
| `after_snapshot` | json | 操作后快照 |
| `client_entry_id` | varchar | 客户端条目 ID |
---
## 公式库
### 接口
| 方法 | 路径 | 说明 |
|------|------|------|
| GET | `spreadsheet-formula/list` | 公式列表 |
| GET | `spreadsheet-formula/detail` | 公式详情 |
| POST | `spreadsheet-formula/create` | 创建公式 |
| POST | `spreadsheet-formula/update` | 更新公式 |
| POST | `spreadsheet-formula/delete` | 删除公式 |
### 关联类
| 类 | 文件 | 说明 |
|----|------|------|
| `SpreadsheetFormulaController` | `app/Http/Controllers/admin/system/SpreadsheetFormulaController.php` | 控制器 |
| `SpreadsheetFormulaService` | `app/Service/admin/system/SpreadsheetFormulaService.php` | 业务服务 |
### 关联模型
| 模型 | 表名 | 说明 |
|------|------|------|
| `SpreadsheetFormulaModel` | `xk_spreadsheet_formula` | 画布公式库 |
### 字段说明
| 字段 | 类型 | 说明 |
|------|------|------|
| `code` | varchar | 公式编码(唯一) |
| `name` | varchar | 公式名称 |
| `description` | varchar | 公式描述 |
| `expression_template` | text | 表达式模板 |
| `ref_slots` | json | 引用槽位 |
| `sort` | int | 排序 |
| `status` | tinyint | 状态 |