Tables

var docDefinition = {
 content: [
 {
 layout: 'lightHorizontalLines', // optional
 table: {
 // headers are automatically repeated if the table spans over multiple pages
 // you can declare how many rows should be treated as headers
 headerRows: 1,
 widths: [ '*', 'auto', 100, '*' ],
 body: [
 [ 'First', 'Second', 'Third', 'The last one' ],
 [ 'Value 1', 'Value 2', 'Value 3', 'Value 4' ],
 [ { text: 'Bold value', bold: true }, 'Val 2', 'Val 3', 'Val 4' ]
 ]
 }
 }
 ]
};

Own table layouts

pdfMake.tableLayouts = {
 exampleLayout: {
 hLineWidth: function (i, node) {
 if (i === 0 || i === node.table.body.length) {
 return 0;
 }
 return (i === node.table.headerRows) ? 2 : 1;
 },
 vLineWidth: function (i) {
 return 0;
 },
 hLineColor: function (i) {
 return i === 1 ? 'black' : '#aaa';
 },
 paddingLeft: function (i) {
 return i === 0 ? 0 : 8;
 },
 paddingRight: function (i, node) {
 return (i === node.table.widths.length - 1) ? 0 : 8;
 }
 }
};
// download the PDF
pdfMake.createPdf(docDefinition).download();

Lists

var docDefinition = {
 content: [
 'Bulleted list example:',
 {
 // to treat a paragraph as a bulleted list, set an array of items under the ul key
 ul: [
 'Item 1',
 'Item 2',
 'Item 3',
 { text: 'Item 4', bold: true },
 ]
 },
 'Numbered list example:',
 {
 // for numbered lists set the ol key
 ol: [
 'Item 1',
 'Item 2',
 'Item 3'
 ]
 }
 ]
};

Headers and footers

var docDefinition = {
 header: 'simple text',
 footer: {
 columns: [
 'Left part',
 { text: 'Right part', alignment: 'right' }
 ]
 },
 content: (...)
};

var docDefinition = {
 footer: function(currentPage, pageCount) { return currentPage.toString() + ' of ' + pageCount; },
 header: function(currentPage, pageCount, pageSize) {
 // you can apply any logic and return any valid pdfmake element
 return [
 { text: 'simple text', alignment: (currentPage % 2) ? 'left' : 'right' },
 { canvas: [ { type: 'rect', x: 170, y: 32, w: pageSize.width - 170, h: 40 } ] }
 ]
 },
 (...)
};

Background-layer

var docDefinition = {
 background: 'simple text',
 content: (...)
};

var docDefinition = {
 background: function(currentPage) {
 return 'simple text on page ' + currentPage
 },
 content: (...)
};

Margins

(...)
// margin: [left, top, right, bottom]
{ text: 'sample', margin: [ 5, 2, 10, 20 ] },
// margin: [horizontal, vertical]
{ text: 'another text', margin: [5, 2] },
// margin: equalLeftTopRightBottom
{ text: 'last one', margin: 5 }
(...)

Stack of paragraphs

var docDefinition = {
 content: [
 'paragraph 1',
 'paragraph 2',
 {
 columns: [
 'first column is a simple text',
 [
 // second column consists of paragraphs
 'paragraph A',
 'paragraph B',
 'these paragraphs will be rendered one below another inside the column'
 ]
 ]
 }
 ]
};

var docDefinition = {
 content: [
 'paragraph 1',
 'paragraph 2',
 {
 columns: [
 'first column is a simple text',
 {
 stack: [
 // second column consists of paragraphs
 'paragraph A',
 'paragraph B',
 'these paragraphs will be rendered one below another inside the column'
 ],
 fontSize: 15
 }
 ]
 }
 ]
};

Images

var docDefinition = {
 content: [
 {
 // you'll most often use dataURI images on the browser side
 // if no width/height/fit is provided, the original size will be used
 image: 'data:image/jpeg;base64,...encodedContent...'
 },
 {
 // if you specify width, image will scale proportionally
 image: 'data:image/jpeg;base64,...encodedContent...',
 width: 150
 },
 {
 // if you specify both width and height - image will be stretched
 image: 'data:image/jpeg;base64,...encodedContent...',
 width: 150,
 height: 150
 },
 {
 // you can also fit the image inside a rectangle
 image: 'data:image/jpeg;base64,...encodedContent...',
 fit: [100, 100]
 },
 {
 // if you reuse the same image in multiple nodes,
 // you should put it to to images dictionary and reference it by name
 image: 'mySuperImage'
 },
 {
 // under NodeJS (or in case you use virtual file system provided by pdfmake)
 // you can also pass file names here
 image: 'myImageDictionary/image1.jpg'
 }
 ],
 images: {
 mySuperImage: 'data:image/jpeg;base64,...content...'
 }
};

Page dimensions, orientation and margins

var docDefinition = {
 // a string or { width: number, height: number }
 pageSize: 'A5',
 // by default we use portrait, you can change it to landscape if you wish
 pageOrientation: 'landscape',
 // [left, top, right, bottom] or [horizontal, vertical] or just a number for equal margins
 pageMargins: [ 40, 60, 40, 60 ],
};

{
 pageOrientation: 'portrait',
 content: [
 {text: 'Text on Portrait'},
 {text: 'Text on Landscape', pageOrientation: 'landscape', pageBreak: 'before'},
 {text: 'Text on Landscape 2', pageOrientation: 'portrait', pageBreak: 'after'},
 {text: 'Text on Portrait 2'},
 ]
}

Document Metadata

var docDefinition = {
 info: {
	title: 'awesome Document',
	author: 'john doe',
	subject: 'subject of document',
	keywords: 'keywords for document',
 },
 content: 'This is an sample PDF printed with pdfMake'
}

Compression

var docDefinition = {
 compress: false,
 content: (...)
};

Building from sources

git clone https://github.com/bpampuch/pdfmake.git
cd pdfmake
npm install # or: yarn
git submodule update --init libs/FileSaver.js
npm run build # or: yarn run build

Coming soon

License