Univer Boards API

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

Facade API est la couche d'application sur les services et les modèles d'unités Univer. Elle couvre les opérations communes de la Commission : création d'une carte, lecture de la page active, ajout d'éléments, mise à jour des conteneurs et gestion des nageuses.

Attention

Les mutations des cartes sont synchrones et renvoient soit un boolean soit une poignée nulle. Vérifiez la valeur de retour avant de lire le résultat.

Activer le point d’entrée de Facade

Les panneaux sont distribués sous forme de plugins Web SDK. Importez l'entrée de façade pour la capacité de la carte que l'application utilise:

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

La vérification de la disposition et les captures ci-dessous nécessitent aussi l’enregistrement de UniverBoardsUIPlugin et cet import.

TypeScript
import '@univerjs-pro/boards-ui/facade'

Créer l'objet API après l'instance Univer et les plugins requis ont été enregistrés :

TypeScript
const univerAPI = FUniver.newAPI(univer)

Créer et lire un board

createBoard crée une unité Board à travers la façade. Dans le code de configuration de niveau inférieur, 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 retourné est le point d'entrée de la page active et de son contenu. Les guides suivants décrivent en détail les opérations individuelles :

  • É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.

Vérifier la disposition du tableau et prendre des captures

Exécutez les exemples ci-dessous une fois le tableau affiché dans le navigateur.

Repérer les problèmes de disposition

analyzeRenderedLayout() signale des problèmes tels que des connecteurs de croisement ou des textes qui ne s'intègrent pas dans une forme. L'appel ne signale que les problèmes et laisse la mise en page inchangée. Chaque numéro porte rule, ce qui donne le type de problème, et focusBounds qui donne la zone à inspecter.

TypeScript
const board = univerAPI.getActiveBoard()if (!board) throw new Error('No active board')const analysis = board.analyzeRenderedLayout()if (!analysis) throw new Error('The board is not ready for layout inspection')for (const { rule, focusBounds } of analysis.issues) {  console.log(rule, focusBounds)}

analyzeRenderedLayout()

Capturer un élément précis

Pour inclure une image d'une étape de l'organigramme dans une déclaration, remplacez review-step par l'ID de l'élément de cette étape. resolveCaptureBounds() calcule la zone à capturer. Passez cette zone à getScreenshot() pour obtenir une URL de données PNG qui peut être utilisée comme source d'image.

TypeScript
const board = univerAPI.getActiveBoard()if (!board) throw new Error('No active board')const target = board.resolveCaptureBounds({ elementIds: ['review-step'], padding: 16 })if (!target || !target.ok) throw new Error('Cannot locate the element to capture')const screenshot = await board.getScreenshot({ bounds: target.bounds })if (!screenshot) throw new Error('Cannot capture the selected area')console.log(screenshot.dataUrl)

resolveCaptureBounds() · getScreenshot()

Références

Que pensez-vous de ce guide ?

© 2026 DreamNum Co., Ltd.