Univer Boards API

Découvrez comment utiliser Facade API dans une application Univer Boards.

Facade API fournit une couche destinée aux applications au-dessus des services et des modèles d’unité Univer. Utilisez-la pour les opérations Board courantes, comme créer des boards, lire les pages actives, ajouter des éléments, mettre à jour des conteneurs et gérer les couloirs.

Attention

Les mutations Board sont synchrones et renvoient un boolean ou un objet nullable. Vérifiez la valeur de retour.

Activer le point d’entrée de Facade

Boards est distribué sous forme de plugins Web SDK. Importez le point d’entrée de Facade correspondant à la fonctionnalité Board utilisée par votre application :

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

Créez l’objet API après avoir enregistré l’instance Univer et les plugins requis :

TypeScript
const univerAPI = FUniver.newAPI(univer)

Créer et lire un board

Utilisez createBoard pour créer une unité Board par l’intermédiaire de la couche Facade. Dans le code de configuration de plus bas niveau, créez l’unité avec 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())

Poursuivre avec les fonctionnalités principales

L’objet FBoard renvoyé est le point d’entrée vers la page active et son contenu. Consultez les guides spécialisés pour les opérations détaillées :

  • Éléments présente la lecture, l’insertion, la connexion, la transformation, l’organisation et la suppression des éléments Board.
  • Conteneurs et couloirs présente les groupes encadrés, l’appartenance et la structure des couloirs.

Références

Que pensez-vous de ce guide ?

© 2026 DreamNum Co., Ltd.