Impression

Imprimer envoie du contenu de tableur à une imprimante, ou l'exporte en format PDF pour la lecture et le partage hors ligne.

Mode extension

Installation

Shell
pnpm add @univerjs-pro/sheets-print

Utilisation

TypeScript
import { UniverSheetsPrintPlugin } from '@univerjs-pro/sheets-print'import SheetsPrintPluginEnUS from '@univerjs-pro/sheets-print/locale/en-US'import { LocaleType, mergeLocales, Univer } from '@univerjs/core'import '@univerjs-pro/sheets-print/lib/index.css'const univer = new Univer({  locale: LocaleType.EN_US,  locales: {    [LocaleType.EN_US]: mergeLocales(      SheetsPrintPluginEnUS,     ),  },})univer.registerPlugin(UniverSheetsPrintPlugin)

Si vous possédez une licence commerciale Univer, consultez Utilisation de la licence dans le client pour la configuration du client.

Configuration des plugins

UniverSheetsPrintPlugin

  • enforceWatermark
    booleanValeur par défaut: false
    Force l’affichage du filigrane à l’impression.

Prise en charge mobile

Configurez d'abord le éditeur mobile. Dans la configuration en mode plugin sur cette page, remplacez les enregistrements de bureau listés ci-dessous par les exportations mobiles des mêmes paquets, et remplissez le remplacement avant d'ouvrir un document . Les modèles plugins, styles, locales et importations Facade restent inchangés. N'enregistrez pas les deux variantes.

PaquetInscription de bureauInscription mobile
@univerjs-pro/sheets-printUniverSheetsPrintPluginUniverSheetsPrintMobileUIPlugin

Mode prédéfini

L'impression est incluse dans le préréglage @univerjs/preset-sheets-advanced.

Installation

UniverSheetsAdvancedPreset de @univerjs/preset-sheets-advanced nécessite le préréglage UniverSheetsDrawingPreset à l'exécution, donc installer @univerjs/preset-sheets-drawing d'abord.

Shell
pnpm add @univerjs/preset-sheets-drawing @univerjs/preset-sheets-advanced

Utilisation

TypeScript
import { UniverSheetsAdvancedPreset } from '@univerjs/preset-sheets-advanced'import UniverPresetSheetsAdvancedEnUS from '@univerjs/preset-sheets-advanced/locales/en-US'import { UniverSheetsCorePreset } from '@univerjs/preset-sheets-core'import UniverPresetSheetsCoreEnUS from '@univerjs/preset-sheets-core/locales/en-US'import { UniverSheetsDrawingPreset } from '@univerjs/preset-sheets-drawing'import UniverPresetSheetsDrawingEnUS from '@univerjs/preset-sheets-drawing/locales/en-US'import { createUniver, LocaleType, mergeLocales } from '@univerjs/presets'import '@univerjs/preset-sheets-core/lib/index.css'import '@univerjs/preset-sheets-drawing/lib/index.css'import '@univerjs/preset-sheets-advanced/lib/index.css'const { univerAPI } = createUniver({  locale: LocaleType.EN_US,  locales: {    [LocaleType.EN_US]: mergeLocales(      UniverPresetSheetsCoreEnUS,      UniverPresetSheetsDrawingEnUS,       UniverPresetSheetsAdvancedEnUS,     ),  },  presets: [    UniverSheetsCorePreset(),    UniverSheetsDrawingPreset(),     UniverSheetsAdvancedPreset(),   ],})

Si vous possédez une licence commerciale Univer, consultez Utilisation de la licence dans le client pour la configuration du client.

Configuration de préréglage

UniverSheetsAdvancedPreset

  • print
    object
    Paramètres pour la fonction sélectionnée.
    • enforceWatermark
      booleanPar défaut: false
      Afficher le filigrane lors de l'impression.

Facade API

Importation

Note du mode greffon

En mode plugin, importez le paquet Facade manuellement. En mode préréglage, le paquet Facade correspondant est déjà inclus.

TypeScript
import '@univerjs-pro/sheets-print/facade'

Ouvrir la boîte de dialogue de configuration de l’impression

Appelez FWorkbook.openPrintDialog pour ouvrir la boîte de dialogue de configuration d'impression.

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()fWorkbook.openPrintDialog()

Fermer la boîte de dialogue de configuration de l’impression

FWorkbook.closePrintDialog ferme la boîte de dialogue de configuration d'impression.

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()fWorkbook.openPrintDialog()// Close the print configuration dialog after 3 secondssetTimeout(() => {  fWorkbook.closePrintDialog()}, 3000)

Mettre à jour la configuration de la mise en page

Appelez FWorkbook.updatePrintConfig(config: ISheetPrintLayoutConfig) pour modifier la configuration de mise en page d'impression.

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getActiveSheet()const subUnitId = fWorksheet.getSheetId()// Update print layout configfWorkbook.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 configurationfWorkbook.print()

Le type de configuration complet et ses paramètres sont listés sous FWorkbook.updatePrintConfig().

Mettre à jour la configuration du rendu d’impression

Appelez FWorkbook.updatePrintRenderConfig(config: ISheetPrintRenderConfig) pour modifier la façon dont la sortie d'impression est rendue.

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()// Update print layout config by defaultfWorkbook.updatePrintConfig({})// Update print render configfWorkbook.updatePrintRenderConfig({gridlines: true, // show gridlineshAlign: univerAPI.Enum.PrintAlign.Middle, // horizontal align middlevAlign: univerAPI.Enum.PrintAlign.Middle, // vertical align middleheaderFooter: [ // 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 printfWorkbook.print()

Le type de configuration complet et ses paramètres sont listés sous FWorkbook.updatePrintRenderConfig().

Imprimer

FWorkbook.print ouvre directement la boîte de dialogue d'impression.

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

Enregistrer une capture d’écran dans le presse-papiers

FWorkbook.saveScreenshotToClipboard copie une image des données d'impression dans le presse-papiers.

Sortie à partir d'une fonctionnalité que vous n'avez pas de licence pour porter un filigrane de licence. L'API renvoie false si l'écriture au presse-papiers échoue.

L'opération de sauvegarde utilise l'API Clipboard, de sorte qu'il peut échouer dans des environnements réseau non sécurisés ou dans des navigateurs qui ne le prennent pas en charge. true.

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const result = await fWorkbook.saveScreenshotToClipboard()

Obtenir une capture d’écran de la plage sélectionnée

FRange.getScreenshot retourne une capture d'écran des données d'impression sélectionnées.

Sortie à partir d'une fonctionnalité que vous n'avez pas de licence pour porter un filigrane de licence. L'API retourne une chaîne d'images de base64 en cas de succès, ou false si le rendu échoue.

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

Écouteurs d’événements

L'impression fait le feu aux événements suivants:

univerAPI.Event.BeforeSheetPrintOpen s'allume avant que la boîte de dialogue de configuration d'impression ne s'ouvre.

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 s'allume après l'ouverture de la boîte de dialogue de configuration d'impression.

TypeScript
const disposable = univerAPI.addEvent(univerAPI.Event.SheetPrintOpen, (params) => {  const { workbook, worksheet } = params})// Remove the event listener, use `disposable.dispose()`.

univerAPI.Event.BeforeSheetPrintConfirm s'allume avant que la boîte de dialogue de confirmation d'impression ne s'ouvre.

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 s'allume après l'ouverture de la boîte de dialogue de confirmation d'impression.

TypeScript
const disposable = univerAPI.addEvent(univerAPI.Event.SheetPrintConfirmed, (params) => {  const { renderConfig, layoutConfig } = params})// Remove the event listener, use `disposable.dispose()`.

univerAPI.Event.BeforeSheetPrintCanceled s'allume avant qu'une annulation d'impression ne soit engagée.

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 s'allume après une annulation d'impression.

TypeScript
const disposable = univerAPI.addEvent(univerAPI.Event.SheetPrintCanceled, (params) => {  const { renderConfig, layoutConfig } = params})// Remove the event listener, use `disposable.dispose()`.

Que pensez-vous de ce guide ?

© 2026 DreamNum Co., Ltd.