Univer Boards API

Aprende a usar la API Facade en una aplicación Univer Boards.

La API de Facade proporciona una capa orientada a la aplicación sobre los servicios y modelos de unidades de Univer. Úselo para operaciones comunes del tablero, como crear tableros, leer páginas activas, agregar elementos, actualizar contenedores y administrar carriles.

Precaución

Las mutaciones de Board son síncronas y devuelven boolean o un identificador anulable. Compruebe el valor devuelto.

Habilite la entrada de fachada

Los tableros se distribuyen como complementos de Web SDK. Importe la entrada de fachada para la capacidad del tablero utilizada por su aplicación:

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

Cree el objeto API después de que se registren la instancia de Univer y los complementos necesarios:

TypeScript
const univerAPI = FUniver.newAPI(univer)

Cree y lea un tablero

Utilice createBoard para crear una unidad de tablero a través de la capa de fachada. En el código de configuración de nivel inferior, cree la unidad con univer.createUnit(UniverInstanceType.UNIVER_BOARD, snapshot).

TypeScript
const board = univerAPI.createBoard({  id: 'board-demo',  name: 'Board Demo',})const activeBoard = univerAPI.getActiveBoard()const sameBoard = univerAPI.getBoard(board.getId())

Continuar con las funciones principales

El objeto FBoard devuelto es el punto de entrada a la página activa y su contenido. Continúa con las guías específicas para ver las operaciones detalladas:

  • Elementos explica cómo leer, insertar, conectar, transformar, organizar y eliminar elementos del Board.
  • Contenedores y carriles explica los grupos enmarcados, la pertenencia y la estructura de los carriles.

Referencia

¿Cómo es esta guía?

© 2026 DreamNum Co., Ltd.