权限

可以将整个 Base 设为只读,也可以只将某张表、某个字段、某条记录或某个视图设为只读。这涵盖只读报表,以及只允许用户修改部分数据的应用场景。

调用这些 API 前,需要先注册 Bases 插件并导入 @univerjs-pro/bases/facade。

整个 Base 只读

TypeScript
const base = univerAPI.getActiveBase()if (!base) throw new Error('Open a Base first')await base.getPermission().setReadOnly()console.log(base.getPermission().canEdit()) // falseawait base.getPermission().setEditable()

指定对象只读

以下示例限制单张表的编辑权限:

TypeScript
const table = base.getTables()[0]if (!table) throw new Error('Create a table first')await table.getPermission().setReadOnly()await table.getPermission().setEditable()

字段、记录和视图同样提供 getPermission(),仪表盘和透视视图在注册对应插件后也可使用。将下层对象设为可编辑,并不会解除上层对象的限制:如果表是只读的,单独将表中的记录设为可编辑不会产生任何效果。

setReadOnly() 和 setEditable() 返回 Promise,需要 await。要一次修改多个对象,可使用 base.getPermission().setObjectPermissions(),参数见 Bases Facade。

复制、导出和评论

Base 级权限还决定复制、导出和评论是否可用。例如,关闭复制:

TypeScript
import { UnitAction } from '@univerjs/protocol'await base.getPermission().setPoint(UnitAction.Copy, false)

导出和评论分别使用 UnitAction.Export 和 UnitAction.Comment。

接入业务权限

本地权限控制编辑器允许执行的操作。协同应用还必须在服务端校验内容读取、加入协同和提交修改,见服务端集成。

测试时应分别使用编辑者、查看者和无权限用户进行验证,页面上的操作和直接发出的请求都需要覆盖。

你觉得这篇文档如何?

© 2026 DreamNum Co., Ltd.