PDFOptions 介面

透過 Page.pdf() 設定 PDF 生成的有效選項。

簽名

export interface PDFOptions

屬性

屬性	修飾詞	類型	描述	預設值
displayHeaderFooter	可選	boolean	是否顯示頁首和頁尾。	false
footerTemplate	可選	string	用於列印頁尾的 HTML 範本。 與 PDFOptions.headerTemplate 具有相同的約束和對特殊類別的支援。
format	可選	PaperFormat	備註 如果設定，此選項會優先於 `width` 和 `height` 選項。	letter.
headerTemplate	可選	string	用於列印頁首的 HTML 範本。 應為有效的 HTML，並使用以下類別將值注入其中 date 格式化的列印日期 title 文件標題 url 文件位置 pageNumber 當前頁碼 totalPages 文件中的總頁數
height	可選	string | number	設定紙張的高度。您可以傳入數字或帶有單位的字串。
landscape	可選	boolean	是否以橫向列印。	false
margin	可選	PDFMargin	設定 PDF 邊距。	undefined 未設定邊距。
omitBackground	可選	boolean	隱藏預設的白色背景，並允許生成具有透明度的 PDF。	false
outline	可選	boolean	(實驗性) 生成文件大綱。	false
pageRanges	可選	string	要列印的頁面範圍，例如 `1-5, 8, 11-13`。	空字串，表示列印所有頁面。
path	可選	string	儲存檔案的路徑。 備註 如果路徑是相對路徑，則會相對於目前的工作目錄解析。	undefined，表示不會將 PDF 寫入磁碟。
preferCSSPageSize	可選	boolean	優先使用頁面中宣告的任何 CSS `@page` 大小，而不是 `width` 或 `height` 或 `format` 選項中宣告的大小。	false，將會縮放內容以符合紙張大小。
printBackground	可選	boolean	設定為 `true` 以列印背景圖形。	false
scale	可選	number	縮放網頁的渲染。值必須介於 `0.1` 和 `2` 之間。	1
tagged	可選	boolean	(實驗性) 生成標記 (可存取) 的 PDF。	true
timeout	可選	number	逾時時間，以毫秒為單位。傳入 `0` 以停用逾時。 可以使用 Page.setDefaultTimeout() 變更預設值	30_000
waitForFonts	可選	boolean	如果為 true，則會等待 `document.fonts.ready` 解析。 如果頁面在背景中，這可能需要使用 Page.bringToFront() 啟用頁面。	true
width	可選	string | number	設定紙張的寬度。您可以傳入數字或帶有單位的字串。