Univer Bases API

了解如何在 Univer Bases 应用中使用 Facade API。

Facade API 是构建在 Bases 模型之上、面向应用的一层接口,涵盖创建 Base、表格、字段、记录和视图,以及筛选、排序、分组、选区和 UI 导航等常用操作。

注意

Base 模型的变更是同步的;UI 激活方法返回 Promise,调用时应使用 await。

启用 Facade 入口

应用使用哪项 Bases 能力,就导入对应的 Facade 入口:

TypeScript
import { FUniver } from '@univerjs/core/facade'import '@univerjs-pro/bases/facade'import '@univerjs-pro/bases-ui/facade'

待 Univer 实例和所需插件注册完成后,再创建 API 对象:

TypeScript
const univerAPI = FUniver.newAPI(univer)

创建和读取 Base

createBase 通过 Facade 层创建 Base 单元。需要编写更底层的配置代码时,可直接使用 univer.createUnit(UniverInstanceType.UNIVER_BASE, snapshot) 创建单元。

TypeScript
const base = univerAPI.createBase({  id: 'base-demo',  name: 'Base Demo',})const activeBase = univerAPI.getActiveBase()const sameBase = univerAPI.getBase(base.getId())

创建表格

TypeScript
const table = base.insertTable('Tasks', { primaryFieldName: 'Title' })const status = table.addField('Status', univerAPI.Enum.BaseFieldType.Text)

操作记录

TypeScript
const record = table.addRecord({  Title: 'Write docs',  Status: 'In progress',}, univerAPI.Enum.BaseFieldKeyEnum.Name)record.setValue(status.getId(), 'Done')

操作 UI 状态

@univerjs-pro/bases-ui/facade 提供一组 UI API,用于激活表格和视图、设置选区、滚动、编辑以及操作面板。

TypeScript
const baseUI = univerAPI.getBaseUI()const view = table.getViews()[0]if (!view) throw new Error('No table view')await baseUI.activateTable(table.getId())await baseUI.activateView(view.getId())baseUI.setSelection({  type: 'grid-record',  tableId: table.getId(),  viewId: view.getId(),  recordId: record.getId(),})

参考

你觉得这篇文档如何?

© 2026 DreamNum Co., Ltd.