# @univerjs-pro/sheets-drawing-thread-comment

- Human documentation: [https://docs.univer.ai/reference/packages/plugins/univerjs-pro/sheets-drawing-thread-comment](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/sheets-drawing-thread-comment)

- Agent Markdown: [https://docs.univer.ai/reference/packages/plugins/univerjs-pro/sheets-drawing-thread-comment.md](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/sheets-drawing-thread-comment.md)

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.4.0`

- Source: [packages/plugins/univerjs-pro/sheets-drawing-thread-comment.mdx](https://github.com/dream-num/documentation/blob/dev/content/reference/packages/plugins/univerjs-pro/sheets-drawing-thread-comment.mdx)

---

Comment integration for floating images returned by the Sheets drawing Facade (`FOverGridImage`). Configure [Sheets images](https://docs.univer.ai/guides/sheets/features/images.md) 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](https://docs.univer.ai/guides/sheets/features/comments.md#object-comments).

## 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](https://docs.univer.ai/reference/facade/over-grid-image.md#createcommentasync) for signatures. Import `@univerjs-pro/sheets-drawing-thread-comment/facade` to register these methods.
