Notes
La fonctionnalité de notes permet d’ajouter des commentaires dans les cellules d’une feuille de calcul afin de consigner des informations complémentaires ou d’apporter du contexte. Elle prend en charge différents styles de commentaires et différentes opérations, ce qui facilite la compréhension et le travail collaboratif sur les données.
Mode prédéfini
Installation
pnpm add @univerjs/preset-sheets-notenpm install @univerjs/preset-sheets-noteyarn add @univerjs/preset-sheets-notebun add @univerjs/preset-sheets-noteUtilisation
import { UniverSheetsCorePreset } from '@univerjs/preset-sheets-core'import UniverPresetSheetsCoreEnUS from '@univerjs/preset-sheets-core/locales/en-US'import { UniverSheetsNotePreset } from '@univerjs/preset-sheets-note'import UniverPresetSheetsNoteEnUS from '@univerjs/preset-sheets-note/locales/en-US'import { createUniver, LocaleType, mergeLocales } from '@univerjs/presets'import '@univerjs/preset-sheets-core/lib/index.css'import '@univerjs/preset-sheets-note/lib/index.css'const { univerAPI } = createUniver({ locale: LocaleType.EN_US, locales: { [LocaleType.EN_US]: mergeLocales( UniverPresetSheetsCoreEnUS, UniverPresetSheetsNoteEnUS, ), }, presets: [ UniverSheetsCorePreset(), UniverSheetsNotePreset(), ],})Mode extension
Installation
pnpm add @univerjs/sheets-note @univerjs/sheets-note-uinpm install @univerjs/sheets-note @univerjs/sheets-note-uiyarn add @univerjs/sheets-note @univerjs/sheets-note-uibun add @univerjs/sheets-note @univerjs/sheets-note-uiUtilisation
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'import { UniverSheetsNotePlugin } from '@univerjs/sheets-note'import { UniverSheetsNoteUIPlugin } from '@univerjs/sheets-note-ui'import SheetsNoteUIEnUS from '@univerjs/sheets-note-ui/locale/en-US'import '@univerjs/sheets-note-ui/lib/index.css'import '@univerjs/sheets-note/facade'const univer = new Univer({ locale: LocaleType.EN_US, locales: { [LocaleType.EN_US]: mergeLocales( SheetsNoteUIEnUS, ), },})univer.registerPlugin(UniverSheetsNotePlugin)univer.registerPlugin(UniverSheetsNoteUIPlugin)Facade API
Les définitions de types complètes de l’API Facade sont disponibles dans la référence de l’API Facade.
Importation
Remarque sur le mode extension
Seul le mode extension nécessite d’importer manuellement le package Facade. Le mode prédéfini inclut déjà le package Facade correspondant, aucune importation supplémentaire n’est donc nécessaire.
import '@univerjs/sheets-note/facade'Récupérer les notes
Utilisez FWorksheet.getNotes pour récupérer toutes les notes de la feuille de calcul.
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getActiveSheet()const notes = fWorksheet.getNotes()notes.forEach((item) => { const { row, col, note } = item console.log(`Cell ${fWorksheet.getRange(row, col).getA1Notation()} has note: ${note}`)})Utilisez FRange.getNote pour récupérer la note de la cellule située en haut à gauche de la plage.
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getActiveSheet()const fRange = fWorksheet.getRange('A1:D10')const note = fRange.getNote()Ajouter ou mettre à jour des notes
Utilisez FRange.createOrUpdateNote pour créer ou mettre à jour la note de la cellule située en haut à gauche de la plage.
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getActiveSheet()const fRange = fWorksheet.getRange('A1')fRange.createOrUpdateNote({ note: 'This is an annotation', width: 160, height: 100, show: true,})Supprimer des notes
Utilisez FRange.deleteNote pour supprimer la note de la cellule située en haut à gauche de la plage.
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getActiveSheet()const notes = fWorksheet.getNotes()if (notes.length > 0) { // Remove the first annotation in the worksheet const { row, col } = notes[0] fWorksheet.getRange(row, col).deleteNote()}// Remove the annotation in cell C1const fRange = fWorksheet.getRange('C1')fRange.deleteNote()Écouteurs d’événements
Les définitions de types complètes des événements sont disponibles dans la documentation des événements.
| Nom de l’événement | Description |
|---|---|
SheetNoteAdd | Déclenché après l’ajout d’une note |
SheetNoteDelete | Déclenché après la suppression d’une note |
SheetNoteUpdate | Déclenché après la mise à jour d’une note |
SheetNoteShow | Déclenché lorsqu’une note est affichée |
SheetNoteHide | Déclenché lorsqu’une note est masquée |
BeforeSheetNoteAdd | Déclenché avant l’ajout d’une note |
BeforeSheetNoteDelete | Déclenché avant la suppression d’une note |
BeforeSheetNoteUpdate | Déclenché avant la mise à jour d’une note |
BeforeSheetNoteShow | Déclenché avant l’affichage d’une note |
BeforeSheetNoteHide | Déclenché avant le masquage d’une note |
Exemples d’écouteurs d’événements
// Triggered after adding an annotationconst disposable = univerAPI.addEvent(univerAPI.Event.SheetNoteAdd, (params) => { const { workbook, worksheet, row, col, note } = params})// Remove event listener using `disposable.dispose()`// Triggered before removing an annotation, can be canceledconst disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetNoteDelete, (params) => { const { workbook, worksheet, row, col, oldNote } = params // Cancel the annotation deletion operation params.cancel = true})// Remove event listener using `disposable.dispose()`Que pensez-vous de ce guide ?