# Images

- Human documentation: [https://docs.univer.ai/guides/docs/features/images](https://docs.univer.ai/guides/docs/features/images)

- Agent Markdown: [https://docs.univer.ai/guides/docs/features/images.md](https://docs.univer.ai/guides/docs/features/images.md)

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

- Source: [docs/features/images.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/docs/features/images.mdx)

---

#### Package metadata

```json
{
  "preset": [
    {
      "client": "@univerjs/preset-docs-drawing",
      "locale": "@univerjs/preset-docs-drawing/locales/en-US",
      "style": "@univerjs/preset-docs-drawing/lib/index.css"
    }
  ],
  "plugins": [
    {
      "client": "@univerjs/drawing"
    },
    {
      "client": "@univerjs/drawing-ui",
      "locale": "@univerjs/drawing-ui/locale/en-US",
      "style": "@univerjs/drawing-ui/lib/index.css"
    },
    {
      "client": "@univerjs/docs-drawing",
      "facade": "@univerjs/docs-drawing/facade"
    },
    {
      "client": "@univerjs/docs-drawing-ui",
      "locale": "@univerjs/docs-drawing-ui/locale/en-US",
      "style": "@univerjs/docs-drawing-ui/lib/index.css"
    }
  ],
  "server": false
}
```

Images can be used to enrich document content, enhance visual expression, and help illustrate or highlight key information.

## Preset Mode

### Installation

#### npm

```bash
npm install @univerjs/preset-docs-drawing
```

#### pnpm

```bash
pnpm add @univerjs/preset-docs-drawing
```

#### yarn

```bash
yarn add @univerjs/preset-docs-drawing
```

#### bun

```bash
bun add @univerjs/preset-docs-drawing
```

### Usage

```typescript
import { UniverDocsCorePreset } from '@univerjs/preset-docs-core'
import UniverPresetDocsCoreEnUS from '@univerjs/preset-docs-core/locales/en-US'
import { UniverDocsDrawingPreset } from '@univerjs/preset-docs-drawing' // [!code ++]
import UniverPresetDocsDrawingEnUS from '@univerjs/preset-docs-drawing/locales/en-US' // [!code ++]
import { createUniver, LocaleType, mergeLocales } from '@univerjs/presets'

import '@univerjs/preset-docs-core/lib/index.css'
import '@univerjs/preset-docs-drawing/lib/index.css' // [!code ++]

const { univerAPI } = createUniver({
  locale: LocaleType.EN_US,
  locales: {
    [LocaleType.EN_US]: mergeLocales(
      UniverPresetDocsCoreEnUS,
      UniverPresetDocsDrawingEnUS, // [!code ++]
    ),
  },
  presets: [
    UniverDocsCorePreset(),
    UniverDocsDrawingPreset(), // [!code ++]
  ],
})
```

If you are using the [Collaboration](https://docs.univer.ai/guides/docs/features/collaboration.md) feature, make sure to pass the `collaboration: true` option in `UniverDocsDrawingPreset`:

```typescript
UniverDocsDrawingPreset({
  collaboration: true, // [!code ++]
})
```

## Plugin Mode

### Installation

#### npm

```bash
npm install @univerjs/drawing @univerjs/drawing-ui @univerjs/docs-drawing @univerjs/docs-drawing-ui
```

#### pnpm

```bash
pnpm add @univerjs/drawing @univerjs/drawing-ui @univerjs/docs-drawing @univerjs/docs-drawing-ui
```

#### yarn

```bash
yarn add @univerjs/drawing @univerjs/drawing-ui @univerjs/docs-drawing @univerjs/docs-drawing-ui
```

#### bun

```bash
bun add @univerjs/drawing @univerjs/drawing-ui @univerjs/docs-drawing @univerjs/docs-drawing-ui
```

### Usage

```typescript
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'
import { UniverDocsDrawingPlugin } from '@univerjs/docs-drawing' // [!code ++]
import { UniverDocsDrawingUIPlugin } from '@univerjs/docs-drawing-ui' // [!code ++]
import DocsDrawingUIEnUS from '@univerjs/docs-drawing-ui/locale/en-US' // [!code ++]
import { UniverDrawingPlugin } from '@univerjs/drawing' // [!code ++]
import { UniverDrawingUIPlugin } from '@univerjs/drawing-ui' // [!code ++]
import DrawingUIEnUS from '@univerjs/drawing-ui/locale/en-US' // [!code ++]

import '@univerjs/drawing-ui/lib/index.css' // [!code ++]
import '@univerjs/docs-drawing-ui/lib/index.css' // [!code ++]

const univer = new Univer({
  locale: LocaleType.EN_US,
  locales: {
    [LocaleType.EN_US]: mergeLocales(
      DrawingUIEnUS, // [!code ++]
      DocsDrawingUIEnUS, // [!code ++]
    ),
  },
})

univer.registerPlugin(UniverDrawingPlugin) // [!code ++]
univer.registerPlugin(UniverDrawingUIPlugin) // [!code ++]
univer.registerPlugin(UniverDocsDrawingPlugin) // [!code ++]
univer.registerPlugin(UniverDocsDrawingUIPlugin) // [!code ++]
```

If you are using the [Collaboration](https://docs.univer.ai/guides/docs/features/collaboration.md) feature, you need to add the `override` configuration:

```typescript
univer.registerPlugin(UniverDrawingPlugin, {
  override: [[IImageIoService, null]], // [!code ++]
})
```

## Facade API

In plugin mode, import the Facade extension first:

```typescript
import '@univerjs/docs-drawing/facade'
```

Use `FDocument` to insert, query, and manage document images:

```typescript
const document = univerAPI.getActiveDocument()
const image = await document?.insertImage({
  source: 'https://example.com/image.png',
  imageSourceType: univerAPI.Enum.ImageSourceType.URL,
  width: 320,
  wrappingStyle: univerAPI.Enum.DocsImageWrappingStyle.INLINE,
})

document?.getImage(image?.getId() ?? '')
document?.getImages()
```

The returned `FDocumentImage` can resize, rotate, reposition, rewrap, reorder, or remove the image.