# Imprimir

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

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

- Requested language: `es-ES`

- Content language: `es-ES`

- Documentation version: `1.2.0`

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

---

#### Package metadata

```json
{
  "mobile": true,
  "preset": [
    {
      "client": "@univerjs/preset-sheets-advanced",
      "locale": "@univerjs/preset-sheets-advanced/locales/en-US",
      "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/en-US",
      "style": "@univerjs-pro/sheets-print/lib/index.css"
    }
  ],
  "license": true,
  "server": false
}
```

La funcionalidad de impresión permite a los usuarios imprimir el contenido de una hoja de cálculo como documentos físicos o exportarlo a formato PDF para verlo y compartirlo sin conexión.

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

## Modo de complemento

### Instalación

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

### Uso

```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 ++]
```

Si tiene una licencia comercial licencia para Univer, consulte [Uso de la licencia en el cliente](https://docs.univer.ai/es-ES/server/license.md#in-plugin-mode) para la configuración.

### Complementos y configuración

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

## Compatibilidad móvil

Configure primero el [editor móvil](https://docs.univer.ai/es-ES/guides/sheets/getting-started/installation.md#mobile-support). En la inicialización en modo plugin de esta página, sustituya los registros de escritorio siguientes por las exportaciones móviles de los mismos paquetes **antes de abrir un documento**. Conserve modelos, estilos, traducciones e importaciones Facade; no registre ambas variantes.

| Paquete                      | Registro de escritorio    | Registro móvil                    |
| ---------------------------- | ------------------------- | --------------------------------- |
| `@univerjs-pro/sheets-print` | `UniverSheetsPrintPlugin` | `UniverSheetsPrintMobileUIPlugin` |

## Modo preestablecido

La funcionalidad de impresión está incluida en el ajuste preestablecido `@univerjs/preset-sheets-advanced`.

### Instalación

> [!NOTE]
> El ajuste preestablecido `UniverSheetsAdvancedPreset` de `@univerjs/preset-sheets-advanced` depende del
> `UniverSheetsDrawingPreset` preestablecido en tiempo de ejecución. Primero instale `@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
```

### Uso

```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 ++]
  ],
})
```

Si tiene una licencia comercial para Univer, consulte [Uso de la licencia en el cliente](https://docs.univer.ai/es-ES/server/license.md#in-preset-mode) para la configuración.

### Preajustes y configuración

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

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

## API de Facade

### Importación

> [!INFO: Plugin mode note]
> Solo el modo complemento requiere importar manualmente el paquete Facade. El modo Preestablecido ya incluye el paquete
> Facade correspondiente, por lo que no se necesita ninguna importación adicional.

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

### Abrir el cuadro de diálogo de configuración de impresión

Usar `FWorkbook.openPrintDialog` puede abrir el cuadro de diálogo de configuración de impresión.

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

fWorkbook.openPrintDialog()
```

### Cerrar el cuadro de diálogo de configuración de impresión

Usar el método `FWorkbook.closePrintDialog` puede cerrar el cuadro de diálogo de configuración de impresión.

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

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

### Actualizar configuración de diseño de impresión

Usar [`FWorkbook.updatePrintConfig(config: ISheetPrintLayoutConfig)`](https://docs.univer.ai/es-ES/reference/facade/workbook.md#updateprintconfig) método para actualizar la configuración del diseño de impresión.

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

Para ver el tipo completo y sus parámetros, consulte [`FWorkbook.updatePrintConfig()`](https://docs.univer.ai/es-ES/reference/facade/workbook.md#updateprintconfig).

### Actualizar configuración de renderizado de impresión

Utilizando el método [`FWorkbook.updatePrintRenderConfig(config: ISheetPrintRenderConfig)`](https://docs.univer.ai/es-ES/reference/facade/workbook.md#updateprintrenderconfig) para actualizar la configuración de renderizado de impresión.

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

Para ver el tipo completo y sus parámetros, consulte [`FWorkbook.updatePrintRenderConfig()`](https://docs.univer.ai/es-ES/reference/facade/workbook.md#updateprintrenderconfig).

### Imprimir

Usando El método `FWorkbook.print` puede activar directamente el cuadro de diálogo de impresión.

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

### Guardar captura de pantalla en el portapapeles

El uso del método `FWorkbook.saveScreenshotToClipboard` le permite guardar la imagen de los datos de impresión en el portapapeles.

Solo disponible con una [licencia](https://docs.univer.ai/es-ES/server/license.md), los usuarios sin licencia enfrentarán restricciones de uso y la operación de guardar volverá `false`.

Utilizamos la API del Portapapeles para guardar la imagen en el portapapeles, lo que puede fallar en entornos de red no seguros o navegadores no compatibles. Un guardado exitoso devolverá `true`.

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

### Obtener captura de pantalla del rango seleccionado

El uso del método `FRange.getScreenshot` le permite obtener una captura de pantalla de los datos de impresión seleccionados.

Solo disponible con una [licencia](https://docs.univer.ai/es-ES/server/license.md), los usuarios sin licencia enfrentarán restricciones de uso y la operación de guardado volverá `false` en caso de error, o una cadena base64 de la imagen en caso de éxito.

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

### Escuchas de eventos

Los siguientes eventos están disponibles para la funcionalidad de impresión:

El evento `univerAPI.Event.BeforeSheetPrintOpen` se activa antes de abrir el cuadro de diálogo de configuración de impresión.

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

El evento `univerAPI.Event.SheetPrintOpen` se activa después de abrir el cuadro de diálogo de configuración de impresión.

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

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

El evento `univerAPI.Event.BeforeSheetPrintConfirm` se activa antes de que se abra el cuadro de diálogo de confirmación de impresión.

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

El evento `univerAPI.Event.SheetPrintConfirmed` se activa después de que se abre el cuadro de diálogo de confirmación de impresión.

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

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

El evento `univerAPI.Event.BeforeSheetPrintCanceled` se activa antes de la operación de cancelación de impresión.

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

El evento `univerAPI.Event.SheetPrintCanceled` se activa después de la cancelación de impresión operación.

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

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