Enregistrements, liens et hiérarchie
Un enregistrement représente un objet commercial, comme une tâche, un client ou une commande. Le Facade API couvre les opérations qui s'appliquent aux enregistrements : écrire un lot, lire une page, relier une autre table et organiser des enregistrements parent-enfant.
Créer et lire des enregistrements
const base = univerAPI.getActiveBase()if (!base) throw new Error('Open a Base first')const table = base.insertTable('Tasks', { primaryFieldName: 'Title' })const titleId = table.getPrimaryFieldId()const records = table.addRecords([ { values: { [titleId]: 'Write documentation' } }, { values: { [titleId]: 'Review examples' } },])records[0].setValue(titleId, 'Publish documentation')const page = table.queryRecords({ offset: 0, limit: 20 })console.log(page.total, page.records)Les valeurs d'enregistrement sont codées par défaut par ID de champ. Si les données sont codées dans un nom de champ, passez univerAPI.Enum.BaseFieldKeyEnum.Name. queryRecords() n'interroge que les données déjà chargées localement; il ne récupère pas les pages d'un moteur. Utilisez viewId pour lire les enregistrements dans le champ d'une vue, ou sort afin de définir la commande.
Supprimer un lot avec table.deleteRecords(recordIds), ou dupliquer un enregistrement avec record.duplicate(). Les deux opérations passent par le système de commande, de sorte que défaire et refaire sont supportés.
Rechercher des enregistrements
Rechercher le texte dans les champs que vous sélectionnez :
const matches = table.search({ query: 'documentation', fieldIds: [titleId], limit: 20 })console.log(matches)Relier une autre table
L'exemple suivant lie chaque tâche à un projet :
const projects = base.insertTable('Projects', { primaryFieldName: 'Name' })const project = projects.addRecord({ [projects.getPrimaryFieldId()]: 'Website' })const projectField = table.addField('Project', univerAPI.Enum.BaseFieldType.RecordLink, { field: { config: { targetTableId: projects.getId(), multiple: false } },})records[0].setLinkedRecordIds(projectField.getId(), [project.getId()])console.log(records[0].getLinkedRecordIds(projectField.getId()))Les cibles liées doivent appartenir à la même base. Définissez multiple: true pour permettre à plus d'un enregistrement lié, displayFieldId de choisir l'étiquette affichée, et pickerFieldIds d'offrir un contexte supplémentaire dans le récupérateur. Lisez et écrivez des ID à travers les API de lien plutôt que de construire des chaînes de stockage internes directement.
Enregistrements parent-enfant
L'exemple suivant fait de l'API un enfant de la tâche de documentation:
const parent = records[0]const parentFieldId = table.getHierarchyFieldId()const child = parent.addChild(parentFieldId, { [titleId]: 'Check API examples' })console.log(child.getParent(parentFieldId)?.getId())child.setParent(parentFieldId, null)Ajouter le premier enfant crée le champ parent-lien requis. Utilisez getChildren(), getAncestors() et getDescendants() pour lire les relations en arrière. Une hiérarchie peut être cinq niveaux de profondeur. Un enregistrement ne peut pas être son propre parent, et les cycles sont rejetés.
La hiérarchie fait partie des données de la table, de sorte que la commutation ou le filtrage des vues ne le modifie pas. Façade des bases documente les méthodes restantes.
Que pensez-vous de ce guide ?