Dataroom Page

DataRoom 页面/大屏设计流程

通过 dataroom-mcp-server 提供的 MCP 工具，按以下流程完成页面或大屏的设计与配置。

工具总览

设计流程

第一步：了解可用组件

调用 listComponents 获取系统中所有可用组件的列表，包括 componentName、displayName 和 description。

CallMcpTool:
  server_name: dataroom-mcp-server
  tool_name: listComponents
  arguments: {}

根据返回结果，确定页面需要用到哪些组件（如 DrText、DrBarChart、DrLineChart 等）。

第二步：确认页面类型

根据用户输入的需求进行意图识别，用户是想创建页面还是想创建大屏，如果你不确定，可以提示用户进行确认

第三步：创建页面实体

调用 dataroom-mcp-server的newPage 创建页面实体，除了id、createDate、createUser、updateDate、updateUser、tenantCode、delFlag字段不需要填写外，其他字段都必须填写。工具调用成功后返回页面ID。 记录返回的页面 ID，后续步骤需要用到。

第四步：设计页面

思考用户想要的页面或大屏需要用到哪些组件，从listComponents 返回的组件列表中选择合适的；

特别注意：

• 如果pageType为page时，那么组件的w表示的占用页面的列数，h表示占用页面的行数，其中页面被拆分为了48列、每行占用的高度是16px，i的值是唯一的且必填
• 可以使用DrHTML组件进行视觉装饰和原生组件无法实现的特殊静态效果，如：
  • 全局渐变背景
  • 网格、纹理、光晕、暗角
  • 面板半透明底板
  • 金色边框、切角、分隔线
  • 标题流光底座
  • 活动氛围装饰，例如“618”标识
  • 纯 CSS 动画
  • 原生组件无法实现的特殊排版或装饰

第五步：获取组件配置

对每个需要添加到页面的组件，调用 getComponentConfig 获取其完整属性定义。

CallMcpTool:
  server_name: dataroom-mcp-server
  tool_name: getComponentConfig
  arguments:
    componentName: "DrBarChart"

返回的 fields 字段是扁平化的配置列表，需要将其转换为 JSON 树结构作为组件的初始化配置。

第六步：更新页面配置

根据页面类型选择调用getPageConfig或getVisualScreenPageConfig获取页面属性定义信息

调用 updatePageConfig 将组件添加到页面并完成布局配置。

chartList 中每个元素代表一个组件实例，包含：

• 组件类型（componentName）
• 位置和尺寸（x, y, width, height）
• 组件属性配置（从第三步的 fields 转换而来）
• 数据源绑定信息
• 组件的配置信息要全量的，不能遗漏

关键注意事项

枚举值大小写

• pageStatus 和 pageType（在 pageEntity / pageStage 层级）：必须使用小写驼峰格式
• pageConfig.pageType（页面配置内部）：必须使用小写驼峰格式，即 directory、visualScreen、page。

组件属性完整性

使用图表组件（如 DrLineChart、DrBarChart、DrPieChart 等）时，必须严格依据 getComponentConfig 返回的 schema 补全所有属性字段， 缺失关键属性会导致运行时报错。

fields 转 JSON 树

getComponentConfig 、getPageConfig 、getVisualScreenPageConfig 返回的 fields 是扁平化列表，需要手动转换为嵌套 JSON 树结构。转换规则：

• 以 . 分隔的字段名表示嵌套层级
• 例如 style.color → { "style": { "color": "value" } }

页面配置结构

pageConfig 必须包含以下四个必需字段：

• basicConfig：页面基础配置（背景色、分辨率等）
• chartList：组件实例数组
• globalVariableList：全局变量数组（可为空数组）
• pageType：页面类型标识（小写）

设计态与发布态

• 设计阶段 pageStatus 设为 design

禁止事项

• 禁止从零手写组件 props。
• 禁止根据其他图表组件推测当前组件字段。
• 禁止因为父级配置为 show: false 或 enabled: false， 就删除其子配置对象。
• 禁止删除值为空、关闭或暂未使用的默认字段。
• 禁止把组件列表信息当作组件完整 Schema。
• 禁止用 DrHtml 实现已有图表组件。
• 禁止在未获取组件默认配置前调用 updatePageConfig。
• 禁止用浅合并覆盖嵌套配置对象。