# 图片

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

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

- Requested language: `zh-CN`

- Content language: `zh-CN`

- Documentation version: `1.0.0-rc.0`

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

---

#### Package metadata

```json
{
  "preset": [
    {
      "client": "@univerjs/preset-docs-drawing",
      "locale": "@univerjs/preset-docs-drawing/locales/zh-CN",
      "style": "@univerjs/preset-docs-drawing/lib/index.css"
    }
  ],
  "plugins": [
    {
      "client": "@univerjs/drawing"
    },
    {
      "client": "@univerjs/drawing-ui",
      "locale": "@univerjs/drawing-ui/locale/zh-CN",
      "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/zh-CN",
      "style": "@univerjs/docs-drawing-ui/lib/index.css"
    }
  ],
  "server": false
}
```

图片可用于丰富文档内容、增强视觉表达和帮助说明或突出重点信息。

## 预设模式

### 安装

#### 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
```

### 使用

```typescript
import { UniverDocsCorePreset } from '@univerjs/preset-docs-core'
import UniverPresetDocsCoreZhCN from '@univerjs/preset-docs-core/locales/zh-CN'
import { UniverDocsDrawingPreset } from '@univerjs/preset-docs-drawing' // [!code ++]
import UniverPresetDocsDrawingZhCN from '@univerjs/preset-docs-drawing/locales/zh-CN' // [!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.ZH_CN,
  locales: {
    [LocaleType.ZH_CN]: mergeLocales(
      UniverPresetDocsCoreZhCN,
      UniverPresetDocsDrawingZhCN, // [!code ++]
    ),
  },
  presets: [
    UniverDocsCorePreset(),
    UniverDocsDrawingPreset(), // [!code ++]
  ],
})
```

如使用[协同编辑](https://docs.univer.ai/zh-CN/guides/docs/features/collaboration.md)功能，请确保在 `UniverDocsDrawingPreset` 中传入 `collaboration: true` 选项。

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

## 插件模式

### 安装

#### 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
```

### 使用

```typescript
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'
import { UniverDocsDrawingPlugin } from '@univerjs/docs-drawing' // [!code ++]
import { UniverDocsDrawingUIPlugin } from '@univerjs/docs-drawing-ui' // [!code ++]
import DocsDrawingUIZhCN from '@univerjs/docs-drawing-ui/locale/zh-CN' // [!code ++]
import { UniverDrawingPlugin } from '@univerjs/drawing' // [!code ++]
import { UniverDrawingUIPlugin } from '@univerjs/drawing-ui' // [!code ++]
import DrawingUIZhCN from '@univerjs/drawing-ui/locale/zh-CN' // [!code ++]

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

const univer = new Univer({
  locale: LocaleType.ZH_CN,
  locales: {
    [LocaleType.ZH_CN]: mergeLocales(
      DrawingUIZhCN, // [!code ++]
      DocsDrawingUIZhCN, // [!code ++]
    ),
  },
})

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

如使用[协同编辑](https://docs.univer.ai/zh-CN/guides/docs/features/collaboration.md)功能，需要添加 `override` 配置：

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

## Facade API

插件模式需要先导入 Facade 扩展：

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

通过 `FDocument` 插入、查询和管理文档图片：

```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()
```

返回的 `FDocumentImage` 可用于调整大小、旋转、定位、环绕方式、层级或删除图片。