# Печать

- Human documentation: [https://docs.univer.ai/ru-RU/guides/sheets/features/print](https://docs.univer.ai/ru-RU/guides/sheets/features/print)

- Agent Markdown: [https://docs.univer.ai/ru-RU/guides/sheets/features/print.md](https://docs.univer.ai/ru-RU/guides/sheets/features/print.md)

- Requested language: `ru-RU`

- Content language: `ru-RU`

- Documentation version: `1.2.0`

- Source: [sheets/features/print.ru-RU.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/sheets/features/print.ru-RU.mdx)

---

#### Package metadata

```json
{
  "mobile": true,
  "preset": [
    {
      "client": "@univerjs/preset-sheets-advanced",
      "locale": "@univerjs/preset-sheets-advanced/locales/ru-RU",
      "style": "@univerjs/preset-sheets-advanced/lib/index.css"
    }
  ],
  "plugins": [
    {
      "client": "@univerjs-pro/sheets-print",
      "facade": "@univerjs-pro/sheets-print/facade",
      "locale": "@univerjs-pro/sheets-print/locale/ru-RU",
      "style": "@univerjs-pro/sheets-print/lib/index.css"
    }
  ],
  "license": true,
  "server": false
}
```

Функция печати позволяет выводить содержимое электронной таблицы на бумагу или экспортировать его в PDF для просмотра без подключения к интернету и совместного использования.

> Interactive example: [Open the playground](/playground/sheets/print)

## Режим пресетов

Функция печати входит в пресет `@univerjs/preset-sheets-advanced`.

### Установка

> [!NOTE]
> Во время выполнения пресету `UniverSheetsAdvancedPreset` из `@univerjs/preset-sheets-advanced` требуется пресет
> `UniverSheetsDrawingPreset`. Сначала установите `@univerjs/preset-sheets-drawing`.

#### npm

```bash
npm install @univerjs/preset-sheets-drawing @univerjs/preset-sheets-advanced
```

#### pnpm

```bash
pnpm add @univerjs/preset-sheets-drawing @univerjs/preset-sheets-advanced
```

#### yarn

```bash
yarn add @univerjs/preset-sheets-drawing @univerjs/preset-sheets-advanced
```

#### bun

```bash
bun add @univerjs/preset-sheets-drawing @univerjs/preset-sheets-advanced
```

### Использование

```typescript
import { UniverSheetsAdvancedPreset } from '@univerjs/preset-sheets-advanced' // [!code ++]
import UniverPresetSheetsAdvancedEnUS from '@univerjs/preset-sheets-advanced/locales/en-US' // [!code ++]
import { UniverSheetsCorePreset } from '@univerjs/preset-sheets-core'
import UniverPresetSheetsCoreEnUS from '@univerjs/preset-sheets-core/locales/en-US'
import { UniverSheetsDrawingPreset } from '@univerjs/preset-sheets-drawing' // [!code ++]
import UniverPresetSheetsDrawingEnUS from '@univerjs/preset-sheets-drawing/locales/en-US' // [!code ++]
import { createUniver, LocaleType, mergeLocales } from '@univerjs/presets'
import '@univerjs/preset-sheets-core/lib/index.css'
import '@univerjs/preset-sheets-drawing/lib/index.css' // [!code ++]
import '@univerjs/preset-sheets-advanced/lib/index.css' // [!code ++]

const { univerAPI } = createUniver({
  locale: LocaleType.EN_US,
  locales: {
    [LocaleType.EN_US]: mergeLocales(
      UniverPresetSheetsCoreEnUS,
      UniverPresetSheetsDrawingEnUS, // [!code ++]
      UniverPresetSheetsAdvancedEnUS, // [!code ++]
    ),
  },
  presets: [
    UniverSheetsCorePreset(),
    UniverSheetsDrawingPreset(), // [!code ++]
    UniverSheetsAdvancedPreset(), // [!code ++]
  ],
})
```

Если у вас есть коммерческая лицензия Univer, инструкции по настройке см. в разделе [Использование лицензии на клиенте](https://docs.univer.ai/ru-RU/server/license.md#in-preset-mode).

### Пресеты и конфигурация

```typescript
interface IUniverSheetsAdvancedPresetConfig {
  print?: Partial<IUniverSheetsPrintConfig>
}

interface IUniverSheetsPrintConfig {
  /**
   * Whether to force the watermark to be displayed when printing
   * @default false
   */
  enforceWatermark?: boolean
}
```

## Режим плагинов

### Установка

#### npm

```bash
npm install @univerjs-pro/sheets-print
```

#### pnpm

```bash
pnpm add @univerjs-pro/sheets-print
```

#### yarn

```bash
yarn add @univerjs-pro/sheets-print
```

#### bun

```bash
bun add @univerjs-pro/sheets-print
```

### Использование

```typescript
import { UniverSheetsPrintPlugin } from '@univerjs-pro/sheets-print' // [!code ++]
import SheetsPrintPluginEnUS from '@univerjs-pro/sheets-print/locale/en-US' // [!code ++]
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'
import '@univerjs-pro/sheets-print/lib/index.css' // [!code ++]

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

univer.registerPlugin(UniverSheetsPrintPlugin) // [!code ++]
```

Если у вас есть коммерческая лицензия Univer, инструкции по настройке см. в разделе [Использование лицензии на клиенте](https://docs.univer.ai/ru-RU/server/license.md#in-plugin-mode).

### Плагины и конфигурация

```typescript
interface IUniverSheetsPrintConfig {
  /**
   * Whether to force the watermark to be displayed when printing
   * @default false
   */
  enforceWatermark?: boolean
}
```

## Поддержка мобильных устройств

Сначала настройте [мобильный редактор](https://docs.univer.ai/ru-RU/guides/sheets/getting-started/installation.md#mobile-support). В коде инициализации режима плагинов на этой странице замените указанные настольные регистрации мобильными экспортами тех же пакетов **до открытия документа**. Сохраните модели, стили, локализации и импорты Facade; не регистрируйте оба варианта.

| Пакет                        | Настольная регистрация    | Мобильная регистрация             |
| ---------------------------- | ------------------------- | --------------------------------- |
| `@univerjs-pro/sheets-print` | `UniverSheetsPrintPlugin` | `UniverSheetsPrintMobileUIPlugin` |

## Facade API

### Импорт

> [!INFO: Примечание о режиме плагинов]
> Импортировать пакет Facade вручную нужно только в режиме плагинов. В режиме пресетов соответствующий пакет Facade уже
> включён, поэтому дополнительный импорт не требуется.

```typescript
import '@univerjs-pro/sheets-print/facade'
```

### Открытие диалогового окна настройки печати

Метод `FWorkbook.openPrintDialog` открывает диалоговое окно настройки печати.

```typescript
const fWorkbook = univerAPI.getActiveWorkbook()

fWorkbook.openPrintDialog()
```

### Закрытие диалогового окна настройки печати

Метод `FWorkbook.closePrintDialog` закрывает диалоговое окно настройки печати.

```typescript
const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.openPrintDialog()

// Close the print configuration dialog after 3 seconds
setTimeout(() => {
  fWorkbook.closePrintDialog()
}, 3000)
```

### Обновление конфигурации макета печати

Метод [`FWorkbook.updatePrintConfig(config: ISheetPrintLayoutConfig)`](https://docs.univer.ai/ru-RU/reference/facade/workbook.md#updateprintconfig) обновляет конфигурацию макета печати.

```typescript
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()
const subUnitId = fWorksheet.getSheetId()

// Update print layout config
fWorkbook.updatePrintConfig({
  area: univerAPI.Enum.PrintArea.CurrentSheet, // print current sheet
  subUnitIds: [subUnitId],
  paperSize: univerAPI.Enum.PrintPaperSize.A4, // A4 paper size
  scale: univerAPI.Enum.PrintScale.FitPage, // fit content to page
  freeze: [univerAPI.Enum.PrintFreeze.Row], // freeze row headers
  margin: univerAPI.Enum.PrintPaperMargin.Normal, // normal margin
  // ... other settings
})

// Start printing with the updated configuration
fWorkbook.print()
```

Полный тип конфигурации и параметры см. в [`FWorkbook.updatePrintConfig()`](https://docs.univer.ai/ru-RU/reference/facade/workbook.md#updateprintconfig).

### Обновление конфигурации рендеринга печати

Метод [`FWorkbook.updatePrintRenderConfig(config: ISheetPrintRenderConfig)`](https://docs.univer.ai/ru-RU/reference/facade/workbook.md#updateprintrenderconfig) обновляет конфигурацию рендеринга печати.

```typescript
const fWorkbook = univerAPI.getActiveWorkbook()

// Update print layout config by default
fWorkbook.updatePrintConfig({})

// Update print render config
fWorkbook.updatePrintRenderConfig({
gridlines: true, // show gridlines
hAlign: univerAPI.Enum.PrintAlign.Middle, // horizontal align middle
vAlign: univerAPI.Enum.PrintAlign.Middle, // vertical align middle
headerFooter: [ // the array of header and footer elements to include, here is page numbers and worksheet name
  univerAPI.Enum.PrintHeaderFooter.PageSize,
  univerAPI.Enum.PrintHeaderFooter.WorksheetTitle,
],
// ... other settings
})

// Start print
fWorkbook.print()
```

Полный тип конфигурации и параметры см. в [`FWorkbook.updatePrintRenderConfig()`](https://docs.univer.ai/ru-RU/reference/facade/workbook.md#updateprintrenderconfig).

### Печать

Метод `FWorkbook.print` позволяет напрямую открыть диалоговое окно печати.

```typescript
// Using the default configuration you can pass in an empty object
workbook.updatePrintConfig({
// ... Print layout configuration
})
workbook.updatePrintRenderConfig({
// ... Print render configuration
})
workbook.print()
```

### Сохранение снимка экрана в буфер обмена

Метод `FWorkbook.saveScreenshotToClipboard` сохраняет изображение данных для печати в буфер обмена.

Эта возможность доступна только при наличии [лицензии](https://docs.univer.ai/ru-RU/server/license.md). Для пользователей без лицензии действуют ограничения, а операция сохранения возвращает `false`.

Для сохранения изображения в буфер обмена используется Clipboard API. В небезопасной сетевой среде или неподдерживаемом браузере операция может завершиться ошибкой. При успешном сохранении возвращается `true`.

```typescript
const fWorkbook = univerAPI.getActiveWorkbook()
const result = await fWorkbook.saveScreenshotToClipboard()
```

### Получение снимка выбранного диапазона

Метод `FRange.getScreenshot` позволяет получить снимок выбранного диапазона данных для печати.

Эта возможность доступна только при наличии [лицензии](https://docs.univer.ai/ru-RU/server/license.md). Для пользователей без лицензии действуют ограничения. При ошибке операция сохранения возвращает `false`, а при успехе — строку изображения в формате base64.

```typescript
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()
const fRange = fWorksheet.getRange('A1:D10')
fRange.getScreenshot()
fRange.getScreenshot({ includeHeaders: true }) // Include row and column headers
```

### Обработчики событий

Для функции печати доступны следующие события:

Событие `univerAPI.Event.BeforeSheetPrintOpen` срабатывает перед открытием диалогового окна настройки печати.

```typescript
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetPrintOpen, (params) => {
  const { workbook, worksheet } = params

  // Cancel open print configuration dialog operation
  params.cancel = true
})

// Remove the event listener, use `disposable.dispose()`.
```

Событие `univerAPI.Event.SheetPrintOpen` срабатывает после открытия диалогового окна настройки печати.

```typescript
const disposable = univerAPI.addEvent(univerAPI.Event.SheetPrintOpen, (params) => {
  const { workbook, worksheet } = params
})

// Remove the event listener, use `disposable.dispose()`.
```

Событие `univerAPI.Event.BeforeSheetPrintConfirm` срабатывает перед открытием диалогового окна подтверждения печати.

```typescript
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetPrintConfirm, (params) => {
  const { renderConfig, layoutConfig } = params

  // Cancel the print confirmation operation
  params.cancel = true
})

// Remove the event listener, use `disposable.dispose()`.
```

Событие `univerAPI.Event.SheetPrintConfirmed` срабатывает после открытия диалогового окна подтверждения печати.

```typescript
const disposable = univerAPI.addEvent(univerAPI.Event.SheetPrintConfirmed, (params) => {
  const { renderConfig, layoutConfig } = params
})

// Remove the event listener, use `disposable.dispose()`.
```

Событие `univerAPI.Event.BeforeSheetPrintCanceled` срабатывает перед отменой печати.

```typescript
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetPrintCanceled, (params) => {
  const { renderConfig, layoutConfig } = params

  // Cancel the print cancel operation
  params.cancel = true
})

// Remove the event listener, use `disposable.dispose()`.
```

Событие `univerAPI.Event.SheetPrintCanceled` срабатывает после отмены печати.

```typescript
const disposable = univerAPI.addEvent(univerAPI.Event.SheetPrintCanceled, (params) => {
  const { renderConfig, layoutConfig } = params
})

// Remove the event listener, use `disposable.dispose()`.
```