Report Designer
Report Designer 构建可打印的、面向导出的业务输出。当用户需要的报表布局比 Dashboard 更可控、又比普通页面更具文档感时,它非常有用。
何时使用
在以下场景使用 Report Designer:
- 财务汇总
- 运营日报或周报
- 面向客户的导出
- 审批包(approval packet)
- 含页眉页脚的可打印表格
- 需要 PDF 或 spreadsheet 导出的 Report
交互式监控请使用 Dashboard Designer。CRUD 工作流请使用 Page Designer。
工作区
Report Designer 采用结构化的撰写工作区:
| 区域 | 用途 |
|---|---|
| Block palette | 添加表格、图表、文本、汇总卡、页眉/页脚 Block |
| 页面画布 | 在类打印页面上编排内容 |
| 属性面板 | 配置数据源、格式、列、分组与导出行为 |
| 工具栏 | 保存、预览、导出与设置 |
Report 输出应在固定页面宽度下可预测,特别是在导出时。
Block 类型
| Block | 用途 |
|---|---|
| 数据表 | 来自某个 Model 或查询的行 |
| 分组表 | 按一个或多个维度分组的数据 |
| 交叉表(Cross-tab) | 矩阵风格的汇总数据 |
| 统计卡 | 突出显示的数值或合计 |
| 图表 | Report 内的可视化摘要 |
| 富文本 | 静态说明或区段备注 |
| 页眉/页脚 | 重复出现的页面条带 |
| 条码或 QR 码 | 启用时的运营标识 |
| 水印 | 草稿、机密或审批状态标记 |
并非每个部署都会启用全部 Block,但元数据模型应保持以 Block 为中心。
数据源
Report 应从稳定的来源读取:
- Model 列表查询
- 命名查询
- 聚合指标
- runtime 页面上下文
- 经审批的、由 API 提供的数据源
对于审计或财务用 Report,优先使用命名查询,以便数据逻辑可在视觉布局之外被评审。
布局指南
- 让 Report 标题与日期区间显示在顶部
- 用页眉表达公司或文档标识
- 在打印宽度下保持密集表格的可读性
- 避免过小的图例
- 使用一致的数字与日期格式
- 用长标签和较大行数进行预览
Report 失败常常是因为 happy path 数据过小。请使用真实的长文本和预期上限的行数进行测试。
导出行为
导出需求应作为设计的一部分,而不是事后才考虑。
| 格式 | 关注点 |
|---|---|
| 分页、页眉、页脚、图表渲染 | |
| Excel | 列名、数据类型、分组行 |
| JSON | 报表 DSL 与解析后的数据集（便于二次处理或归档） |
当 Report 用作具有法律效力或面向客户的产物时,应保留布局的版本化定义。