tabs.PageSettings

类型 tabs.PageSettings 用于控制标签如何通过 tabs.saveAsPDF() 方法渲染为 PDF。

所有属性都是可选的。

要设置页眉和页脚,你可以在提供的字符串中包含某些特殊字符。这些字符将在渲染输出中被替换,替换方式如下

  • "&P": 页码,例如 "2"
  • "&PT": 页码和总页数,例如 "2 of 3"
  • "&D": 当前日期/时间
  • "&T": 页面标题
  • "&U": 页面 URL

类型

此类型的值为对象。它们包含以下属性

edgeBottom 可选

number。页脚底部与纸张底部边缘之间的间距(英寸)。默认值:0。

edgeLeft 可选

number。左页眉/页脚与纸张左侧边缘之间的间距(英寸)。默认值:0。

edgeRight 可选

number。右页眉/页脚与纸张左侧边缘之间的间距(英寸)。默认值:0。

edgeTop 可选

number。页眉顶部与纸张顶部边缘之间的间距(英寸)。默认值:0

footerCenter 可选

string。页面中心页脚的文本。默认值:''。

footerLeft 可选

string。页面左侧页脚的文本。默认值:'&PT'。

footerRight 可选

string。页面右侧页脚的文本。默认值:'&D'。

headerCenter 可选

string。页面中心页眉的文本。默认值:''。

headerLeft 可选

string。页面左侧页眉的文本。默认值:'&T'。

headerRight 可选

string。页面右侧页眉的文本。默认值:'&U'。

marginBottom 可选

number。页面内容与纸张底部边缘之间的边距(英寸)。默认值:0.5。

marginLeft 可选

number。页面内容与纸张左侧边缘之间的边距(英寸)。默认值:0.5。

marginRight 可选

number。页面内容与纸张右侧边缘之间的边距(英寸)。默认值:0.5。

marginTop 可选

number。页面内容与纸张顶部边缘之间的边距(英寸)。默认值:0.5。

orientation 可选

integer。页面方向:0 表示 "纵向",1 表示 "横向"。默认值:0。

paperHeight 可选

number。纸张高度(纸张尺寸单位)。默认值:11.0。

paperSizeUnit 可选

integer。纸张尺寸单位:0 = 英寸,1 = 毫米。默认值:0。

paperWidth 可选

number。纸张宽度(纸张尺寸单位)。默认值:8.5。

scaling 可选

number。页面内容缩放比例。1 表示 100% 或正常尺寸。默认值:1。

showBackgroundColors 可选

boolean。是否显示页面背景颜色。默认值:false。

showBackgroundImages 可选

boolean。是否显示页面背景图像。默认值:false。

shrinkToFit 可选

boolean。是否应缩小页面内容以适应页面宽度(覆盖缩放比例)。默认值:true。

toFileName 可选

string。保存 PDF 文件的名称,包含或不包含 .pdf 扩展名。

浏览器兼容性

BCD 表格仅在启用 JavaScript 的浏览器中加载。