The type tabs.PageSettings
is used to control how a tab is rendered as a PDF by the tabs.saveAsPDF()
method.
All its properties are optional.
For setting headers and footers, you can include certain special characters in the strings you supply. These will be replaced in the rendered output as follows:
- "&P": the page number, like "2"
- "&PT": the page number and the total number of pages, like "2 of 3"
- "&D": the current date/time
- "&T": the page title
- "&U": the page URL
Type
Values of this type are objects. They contain the following properties:
footerCenter
Optionalstring
. The text for the page's center footer. Default: ''.footerLeft
Optionalstring
. The text for the page's left footer. Default: '&PT'.footerRight
Optionalstring
. The text for the page's right footer. Default: '&D'.headerCenter
Optionalstring
. The text for the page's center header. Default: ''.headerLeft
Optionalstring
. The text for the page's left header. Default: '&T'.headerRight
Optionalstring
. The text for the page's right header. Default: '&U'.marginBottom
Optionalnumber
. The margin between the page content and the bottom edge of the paper (inches). Default: 0.5.marginLeft
Optionalnumber
. The margin between the page content and the left edge of the paper (inches). Default: 0.5.marginRight
Optionalnumber
. The margin between the page content and the right edge of the paper (inches). Default: 0.5.marginTop
Optionalnumber
. The margin between the page content and the top edge of the paper (inches). Default: 0.5.orientation
Optionalinteger
. Page orientation: 0 means "portrait", 1 means "landscape". Default: 0.paperHeight
Optionalnumber
. The paper height in paper size units. Default: 11.0.paperSizeUnit
Optionalinteger
. The paper size unit: 0 = inches, 1 = millimeters. Default: 0.paperWidth
Optionalnumber
. The paper width in paper size units. Default: 8.5.scaling
Optionalnumber
. Page content scaling factor. 1 means 100% or normal size. Default: 1.showBackgroundColors
Optionalboolean
. Whether the page background colors should be shown. Default: false.showBackgroundImages
Optionalboolean
. Whether the page background images should be shown. Default: false.shrinkToFit
Optionalboolean
. Whether the page content should shrink to fit the page width (overrides scaling). Default: true.
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Chrome | Edge | Firefox | Firefox for Android | Opera | |
---|---|---|---|---|---|
Basic support | No | No | 56 | No | No |