API Reference

@univerjs/sheets-drawing

Drawing model integration for Univer Sheets.

TypeScript
import { UniverSheetsDrawingPlugin } from '@univerjs/sheets-drawing'univer.registerPlugin(UniverSheetsDrawingPlugin, {})

Entry Points

  • Facade: @univerjs/sheets-drawing/facade

Worksheet background images

The Facade adds FWorksheet.getBackgroundImage(), setBackgroundImage(source, imageSourceType?), and deleteBackgroundImage(). The source type defaults to ImageSourceType.URL. Updates use commands and support undo/redo.

IWorksheetData.backgroundImage stores one tiled image independently of floating images. Add @univerjs/sheets-drawing-ui for rendering and upload controls. Backgrounds are excluded from printing. See the background image guide.

IUniverSheetsDrawingConfig

TypeScript
export interface IUniverSheetsDrawingConfig {}

How is this guide?

© 2026 DreamNum Co., Ltd.