PDFKit

一个用于 Node 和浏览器的 JavaScript PDF 生成库。

描述

PDFKit 是一个用于 Node 和浏览器的 PDF 文档生成库，它使创建复杂、多页面的可打印文档变得简单。该 API 采用链式调用，包含低级功能和高级功能的抽象。PDFKit API 设计简单，因此生成复杂文档通常只需要几个函数调用。

查看一些文档和示例亲自体验！您还可以阅读自生成的 PDF 指南，其中内联显示了示例输出。如果您想了解它是如何生成的，请查看 docs 文件夹中的 README。

您还可以在这里尝试 PDFKit 的交互式浏览器演示。

安装

安装使用 npm 包管理器。安装 npm 后，只需输入以下命令。

npm install pdfkit

功能

矢量图形
- 类似 HTML5 canvas 的 API
- 路径操作
- SVG 路径解析器，便于创建路径
- 变换
- 线性和径向渐变
文本
- 自动换行（识别软连字符）
- 文本对齐
- 项目符号列表
字体嵌入
- 支持 TrueType (.ttf)、OpenType (.otf)、WOFF、WOFF2、TrueType Collections (.ttc) 和 Datafork TrueType (.dfont) 字体
- 字体子集化
- 有关高级字形布局支持的更多详细信息，请参阅 fontkit。
图像嵌入
- 支持 JPEG 和 PNG 文件（包括索引 PNG 和带透明度的 PNG）
注释
- 链接
- 备注
- 高亮
- 下划线
- 等等
AcroForms
大纲
PDF 安全
- 加密
- 访问权限（打印、复制、修改、注释、填写表单、内容访问、文档组装）
辅助功能支持（标记内容、逻辑结构、标记 PDF、PDF/UA）

即将推出！

图案填充
用于创建表格和布局内容的高级 API
更多性能优化
更多令人惊叹的功能，也许由您编写！请 fork 这个仓库并向我发送拉取请求。

示例

const PDFDocument = require('pdfkit');
const fs = require('fs');

// 创建文档
const doc = new PDFDocument();

// 将输出传输到某处，比如文件或 HTTP 响应
// 浏览器使用方法见下文
doc.pipe(fs.createWriteStream('output.pdf'));

// 嵌入字体，设置字体大小，并渲染一些文本
doc
  .font('fonts/PalatinoBold.ttf')
  .fontSize(25)
  .text('使用嵌入字体的一些文本！', 100, 100);

// 添加图像，将其限制在给定大小内，并在垂直和水平方向上居中
doc.image('path/to/image.png', {
  fit: [250, 300],
  align: 'center',
  valign: 'center'
});

// 添加另一页
doc
  .addPage()
  .fontSize(25)
  .text('这里是一些矢量图形...', 100, 100);

// 绘制一个三角形
doc
  .save()
  .moveTo(100, 150)
  .lineTo(100, 250)
  .lineTo(200, 250)
  .fill('#FF3300');

// 应用一些变换并使用"奇偶"填充规则渲染 SVG 路径
doc
  .scale(0.6)
  .translate(470, -380)
  .path('M 250,75 L 323,301 131,161 369,161 177,301 z')
  .fill('red', 'even-odd')
  .restore();

// 添加带注释的文本
doc
  .addPage()
  .fillColor('blue')
  .text('这是一个链接！', 100, 100)
  .underline(100, 100, 160, 27, { color: '#0000FF' })
  .link(100, 100, 160, 27, 'http://google.com/');

// 完成 PDF 文件
doc.end();

此示例的 PDF 输出（略有添加）展示了 PDFKit 的强大功能 —— 使用极少量代码生成复杂文档。更多示例请参见 demo 文件夹和 PDFKit 编程指南。

浏览器使用

在浏览器中使用 PDFKit 有三种方式：

使用 Browserify。查看演示源代码和构建脚本
使用 webpack。查看完整示例。
使用预构建版本。以 pdfkit.standalone.js 文件形式分发在发布版本或包的 js 文件夹中。

除了 PDFKit，您还需要一个地方来传输输出。HTML5 有一个 Blob 对象，可用于存储二进制数据，并获取此数据的 URL，以便在 iframe 中显示 PDF 输出或上传到服务器等。要从 PDFKit 的输出中获取 Blob，可以使用 blob-stream 模块。

以下示例使用 Browserify 或 webpack 加载 PDFKit 和 blob-stream。有关预构建版本使用示例，请参见这里和这里。

// 引入依赖
const PDFDocument = require('pdfkit');
const blobStream = require('blob-stream');

// 创建文档，与上面相同
const doc = new PDFDocument();

// 将文档传输到 blob
const stream = doc.pipe(blobStream());

// 在这里向文档添加内容，如常

// 完成后获取 blob
doc.end();
stream.on('finish', function() {
  // 获取一个可以随意使用的 blob
  const blob = stream.toBlob('application/pdf');

  // 或获取用于在浏览器中显示的 blob URL
  const url = stream.toBlobURL('application/pdf');
  iframe.src = url;
});

您可以在这里查看 PDFKit 的交互式浏览器演示。

注意，为了使用 Browserify 处理使用 PDFKit 的项目，您需要使用 npm 安装 brfs 模块，它用于将内置字体数据加载到包中。它在 PDFKit 的 package.json 中被列为 devDependency，因此默认情况下不会为 Node 用户安装。如果忘记安装，Browserify 将打印错误消息。