html

jsPDF HTML 插件

Source:

Methods

(inner) html(source, optionsopt)

Source:

使用 HTML 元素或字符串生成 PDF。

Example
var doc = new jsPDF();
doc.html(document.body, {
   callback: function (doc) {
     doc.save();
   },
   x: 10,
   y: 10
});
Parameters:
Name Type Attributes Description
source HTMLElement | string

HTML 元素或包含 HTML 的字符串。
options Object <optional>

设置选项

Properties
Name Type Attributes Description
callback function <optional>

回调函数，第一个参数是当前的 jsPDF 实例。
margin number | Array.<number> <optional>

页面边距 [上, 右, 下, 左]。默认是 0。
autoPaging boolean | 'slice' | 'text' <optional>

自动分页模式。

  • false: 自动分页禁用。
  • true 或 'slice': 将形状或文本块跨页分隔。可能会将文本切成两半，难以阅读。
  • 'text': 尝试不跨页分隔文本。最适合包含单列文本的文档。
默认是 true。
filename string <optional>

文件名
image HTMLOptionImage <optional>

HTML 转换为图像时的图像设置
html2canvas Html2CanvasOptions <optional>

html2canvas 选项
fontFaces Array.<FontFace> <optional>

匹配字体时使用的字体列表。字体将根据指定的 URL 添加到 PDF 中。如果省略，字体匹配算法将回退到旧算法。
jsPDF jsPDF <optional>

jsPDF 实例
x number <optional>

PDF 文档中的 x 位置（以 jsPDF 单位为单位）。
y number <optional>

PDF 文档中的 y 位置（以 jsPDF 单位为单位）。
width number <optional>

PDF 文档中的目标宽度（以 jsPDF 单位为单位）。渲染的元素将按比例缩放，以适应指定的宽度。如果未指定 html2canvas.scale 或 windowWidth 选项，则无效果。
windowWidth number <optional>

窗口宽度（以 CSS 像素为单位）。与 html2canvas.windowWidth 选项相反，此选项影响实际容器大小，而不会影响 CSS 媒体查询。此选项仅在指定 width 选项时有效。

Type Definitions

FontFace

Source:
Properties:
Name Type Attributes Description
family string

字体族名称。
style string | undefined

字体样式，例如 'italic'。
weight string | number | undefined

字体粗细，可以是字符串或数字（例如 400, 500, 600）。
stretch string | undefined

字体拉伸，例如 condensed, normal, expanded。
src Array.<Object>

各种格式字体可以获取的 URL 列表。
src string <optional>

特定格式的字体 URL。
src string <optional>

字体格式。