Anotaciones
La funcionalidad de anotaciones permite a los usuarios agregar comentarios en celdas de la hoja de cálculo para registrar información adicional o proporcionar contexto. Admite varios estilos de comentarios y operaciones, lo que ayuda a los usuarios a comprender mejor los datos y colaborar con ellos.
Modo predeterminado
Instalación
pnpm add @univerjs/preset-sheets-notenpm install @univerjs/preset-sheets-noteyarn add @univerjs/preset-sheets-notebun add @univerjs/preset-sheets-noteUso
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(), ],})Modo complemento
Instalación
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-uiUso
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)API de Facade
Las definiciones completas del tipo de API de Facade se pueden encontrar en la FacadeAPI.
Importar
Plugin mode note
Solo el modo complemento requiere importar manualmente el paquete Facade. El modo Preestablecido ya incluye el paquete Facade correspondiente, por lo que no se necesita ninguna importación adicional.
import '@univerjs/sheets-note/facade'Obtener anotaciones
Usar FWorksheet.getNotes para obtener todas las anotaciones en la hoja de trabajo.
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}`)})Usar FRange.getNote para obtener la anotación de la celda superior izquierda en el rango.
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getActiveSheet()const fRange = fWorksheet.getRange('A1:D10')const note = fRange.getNote()Agregar o actualizar anotaciones
Usar FRange.createOrUpdateNote para crear o actualizar la anotación de la celda superior izquierda en el rango.
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,})Eliminar anotaciones
Usar FRange.deleteNote para eliminar la anotación de la celda superior izquierda en el rango.
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()Escuchas de eventos
Las definiciones completas de tipos de eventos se pueden encontrar en Eventos.
| Evento Nombre | Descripción |
|---|---|
SheetNoteAdd | Se activa después de agregar una anotación |
SheetNoteDelete | Se activa después de eliminar una anotación |
SheetNoteUpdate | Se activa después de actualizar una anotación |
SheetNoteShow | Se activa cuando se muestra una anotación |
SheetNoteHide | Se activa cuando se oculta una anotación |
BeforeSheetNoteAdd | Se activa antes de agregar una anotación |
BeforeSheetNoteDelete | Se activa antes de eliminar una anotación |
BeforeSheetNoteUpdate | Activado antes de actualizar una anotación |
BeforeSheetNoteShow | Activado antes de mostrar una anotación |
BeforeSheetNoteHide | Activado antes de ocultar una anotación |
Ejemplos de escuchas de eventos
// 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()`¿Cómo es esta guía?