Structure des données d’un Board
IBoardData
IBoardData est le format d'instantané utilisé par les cartes Univer. Il décrit une unité de la carte, y compris l'ordre des pages, les données de la page, les ressources, les thèmes, la page active, le ratio de zoom et les paramètres de la carte.
Propriétés
| Propriété | Type | Description |
|---|---|---|
| id | string | Identifiant unique de l’unité Board. |
| rev? | number | Valeur de révision optionnelle utilisée par la couche de persistance ou de collaboration. |
| name | string | Nom du Board. |
| appVersion | string | Version du package ayant créé l’instantané. |
| locale? | string | Paramètres régionaux du Board. |
| defaultPageSize | IBoardPageSize | Taille par défaut des pages de la carte. |
| pageOrder | string[] | Liste ordonnée des identifiants de page du Board. |
| pages | Record\<string, IBoardPage\> | Snapshots de page, cliqués par id de page. |
| activePageId? | string | Id de la page active. |
| theme? | IBoardThemeData | Thème actuel du Board. |
| themes? | Record\<string, IBoardThemeData\> | Autres thèmes nommés. |
| zoomRatio? | number | Niveau de zoom actuel. |
| resources? | IResources | Ressources externes utilisées par les images, le texte enrichi, les tableaux et les autres éléments. |
| custom? | `Record<string, unknown> | null` |
| boardSettings? | IBoardSettings | Paramètres d’interface et d’interaction du Board. |
Données des pages
IBoardPage stocke des éléments dans une carte clé par id, et elementOrder définit l'ordre dans lequel ils sont rendus. Conservez les deux structures en synchronisation lorsque vous construisez vous-même un instantané.
TypeScript
const boardData = { id: 'board-1', name: 'Planning board', appVersion: '1.0.0', defaultPageSize: { width: 1920, height: 1080 }, pageOrder: ['page-1'], pages: { 'page-1': { id: 'page-1', pageType: 'page', name: 'Page 1', elementOrder: ['text-1'], elements: { 'text-1': { id: 'text-1', type: 'text', transform: { left: 120, top: 96, width: 240, height: 80 }, text: 'Kickoff', }, }, }, }, activePageId: 'page-1',}Utilisation
Les principales utilisations de IBoardData sont les suivantes:
- Création d'une unité
UniverInstanceType.UNIVER_BOARD. - Persistance et restauration des documents de la Commission.
- Préparation des données pour le traitement de l'importation, de l'exportation ou du côté serveur.
- Seeding a Board avec des pages, des éléments et des paramètres avant le premier rendu.
Les objets Snapshot sont des données de persistance. Une fois qu'un forum est en cours d'exécution, utilisez les API Facade au lieu de muter l'objet snapshot directement.
Que pensez-vous de ce guide ?