PDFOptions インターフェース
Page.pdf() を介した PDF 生成を設定するための有効なオプション。
シグネチャ:
export interface PDFOptions
プロパティ
| プロパティ | 修飾子 | 型 | 説明 | デフォルト |
|---|---|---|---|---|
| displayHeaderFooter | オプション | boolean | ヘッダーとフッターを表示するかどうか。 | false |
| footerTemplate | オプション | string | 印刷フッターの HTML テンプレート。 PDFOptions.headerTemplate と同じ制約と特別なクラスのサポートがあります。 | |
| format | オプション | PaperFormat | letter. | |
| headerTemplate | オプション | string | 印刷ヘッダーの HTML テンプレート。次の値を挿入するために使用される次のクラスを含む有効な HTML である必要があります。 - - - - - | |
| 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 | Web ページのレンダリングを拡大縮小します。量は 0.1 から 2 の間である必要があります。 | 1 |
| tagged | オプション | boolean | タグ付き (アクセシブル) PDF を生成します。 | true |
| timeout | オプション | number | タイムアウト (ミリ秒単位)。タイムアウトを無効にするには 0 を渡します。 | 30_000 |
| width | オプション | string | number | 用紙の幅を設定します。数値または単位付きの文字列を渡すことができます。 |