@univerjs-pro/sheets-drawing-thread-comment
Comment integration for floating images returned by the Sheets drawing Facade (FOverGridImage). Configure Sheets images and register this plugin before opening a workbook.
TypeScript
import { UniverSheetsDrawingThreadCommentPlugin } from '@univerjs-pro/sheets-drawing-thread-comment'import '@univerjs-pro/sheets-drawing-thread-comment/facade'univer.registerPlugin(UniverSheetsDrawingThreadCommentPlugin)const image = univerAPI.getActiveWorkbook()?.getActiveSheet()?.getImages()[0]await image?.createCommentAsync('Replace this image.')The plugin supplies its shared Shape/thread-comment dependencies. It has no configuration options, locales, or styles of its own. Configure comment UI and persistence through the Sheets comments guide.
Facade methods
| Method | Behavior |
|---|---|
createCommentAsync(content, options?) | Creates a comment anchored to the image. Accepts plain text or a document body and optional IDs, author, attachments, and creation time. Resolves to command success; empty content throws TypeError. |
getComments() | Returns locally loaded matching comment threads. |
listCommentsAsync() | Synchronizes known threads, then returns matching comments. |
See the image Facade reference for signatures. Import @univerjs-pro/sheets-drawing-thread-comment/facade to register these methods.
How is this guide?