Tables, champs et enregistrements
Chaque table stocke les définitions de champs, les valeurs d'enregistrement, une matrice de données de cellules optionnelle, les ressources, les vues et les index dont dépendent la logique de rendu et de recherche.
Les nouveaux tableaux ne contiennent aucun enregistrement. Les enregistrements sont ajoutés par le biais du Facade API ou par l'importation de données instantanés.
Instantané d’une table
| Propriété | Type | Description |
|---|---|---|
| id | string | Identifiant de la table. |
| name | string | Nom de la table. |
| fields | Record\<string, IFieldSnapshot\> | Définitions des champs indexées par identifiant de champ. |
| fieldOrder | string[] | Liste ordonnée des identifiants de champs. |
| records | Record\<string, IRecordSnapshot\> | Données des enregistrements indexées par identifiant d’enregistrement. |
| recordOrder? | string[] | Liste ordonnée des identifiants d’enregistrements. |
| primaryFieldId | string | Identifiant du champ principal. |
| views | Record\<string, IViewSnapshot\> | Vues indexées par identifiant de vue. |
| viewOrder | string[] | Liste ordonnée des identifiants de vues. |
| resources? | IBaseResources | Les ressources d'option, de membre et d'attachement sont partagées dans toute la table. |
Instantané d’un champ
| Propriété | Type | Description |
|---|---|---|
| id | string | Identifiant du champ. |
| name | string | Nom du champ. |
| description? | string | Description du champ. |
| type | BaseFieldType | Type du champ. |
| config | Record\<string, unknown\> | Config spécifique au type de champ. |
| defaultValue? | BaseCellValue | Valeur par défaut des nouveaux enregistrements. |
| system? | boolean | Si le champ est géré par le système. |
| readonly? | boolean | Indique si les valeurs sont en lecture seule. |
Types de champs
Les types de champs courants comprennent text, number, currency, progress, rating, checkbox, singleSelect, multiSelect, person, group, date, attachment, formula, createdAt, updatedAt, createdBy et updatedBy.
Utilisez les enums Facade dans le code d'application:
TypeScript
const field = table.addField('Due date', univerAPI.Enum.BaseFieldType.Date)Instantané d’un enregistrement
| Propriété | Type | Description |
|---|---|---|
| id | string | Identifiant de l’enregistrement. |
| values | Record\<string, BaseCellValue\> | Valeurs indexées par identifiant de champ. |
| orderKey | string | Clé d’ordre stable. |
| createdAt | number | Horodatage de création. |
| updatedAt | number | Chronographe de la dernière mise à jour. |
| createdBy? | string | Identifiant de l’auteur. |
| updatedBy? | string | ID de la dernière mise à jour. |
Exemple avec Facade
TypeScript
const table = base.insertTable('Tasks', { primaryFieldName: 'Title' })const title = table.getPrimaryField()const status = table.addField('Status', univerAPI.Enum.BaseFieldType.SingleSelect)const record = table.addRecord({ [title.getId()]: 'Write guide', [status.getId()]: 'In progress',})Que pensez-vous de ce guide ?