布局设计

使用 布局设计 来控制字段在页面中的排布方式。

可以做什么

在布局设计中，你可以：

• 新建布局
• 复制布局
• 编辑布局设置
• 配置页面类型
• 配置布局作用范围
• 设置布局优先级
• 在画布中分组字段
• 从布局中隐藏字段
• 为某个布局设置必填字段
• 为新建页和编辑页配置页面事件
• 为可编辑子表配置子表脚本

布局范围

布局可以配置到不同页面类型，包括：

• 默认
• 列表
• 查看
• 新建
• 编辑
• 关联

布局还支持作用范围和优先级，以便不同用户或上下文匹配不同布局。

画布与组件

布局编辑器包含画布和组件面板。

你可以：

• 将字段拖入分组
• 调整分组结构
• 移动或隐藏字段
• 为当前布局管理必填字段

布局侧边栏还支持：

• 布局信息
• 隐藏字段
• 必填字段
• 布局分组
• 页面事件

页面事件

当新建页或编辑页需要根据当前表单值动态调整运行时行为时，使用 页面事件 Tab。

页面事件按布局配置。运行时页面匹配到该布局后，可以执行选中的 Studio 脚本：

• 页面加载时执行一次
• 任意主表字段变化时执行
• 指定主表字段变化时执行

脚本可以返回运行时 effects，例如：

• 显示、隐藏、必填、禁用或只读主表字段
• 设置主表字段值
• 展示主表字段错误
• 展示消息、通知或弹窗
• 请求运行时刷新

页面脚本配置会保存到表单 custom configuration 的 formPageScripts[layoutId]，不会修改数据库结构。

子表脚本

页面事件 Tab 还支持给当前布局中的可编辑子表配置单独的子表脚本。

子表脚本可以在以下时机执行：

• 子表新增行
• 子表删除行
• 子表字段变化

子表字段变化可以监听全部子表字段，也可以只监听指定子表字段。指定字段使用 子表API名.字段API名 格式。

子表脚本可以返回 effects 来：

• 显示、隐藏、必填、禁用或只读子表字段
• 给某一行或当前所有行设置子表字段值
• 给某一行或当前所有行展示子表字段错误

子表脚本配置会保存到表单 custom configuration 的 formChildPageScripts[layoutId]。

布局类型与匹配规则

布局不只是视觉草图，它还会按照页面类型、作用范围和优先级进行匹配。

适合这些场景：

• 同一个表单需要不同的列表页和详情页布局
• 新建页和编辑页需要不同结构
• 不同主体或上下文需要不同布局版本

什么时候使用布局设计

当字段已经准备好，但页面结构、字段分组或不同页面类型下的呈现方式还需要调整时，就应使用布局设计。

Studio 脚本入参、触发阶段和返回 effects，请查看 页面化。