[WIP] New section node

examples/sections.js

@@ -0,0 +1,90 @@
+var pdfmake = require('../js/index'); // only during development, otherwise use the following line
+//var pdfmake = require('pdfmake');
+
+var Roboto = require('../fonts/Roboto');
+pdfmake.addFonts(Roboto);
+
+var docDefinition = {
+	header: function () { return 'default header'; },
+	footer: function () { return 'default footer'; },
+	background: function() { return { text:'global background', alignment: 'right' }; },
+	watermark: 'default watermark',
+	content: [
+		{
+			section: [
+				'SECTION 1',
+				'Text in section.'
+			]
+		},
+		{
+			header: function (currentPage, pageCount) { return 'header: ' + currentPage.toString() + ' of ' + pageCount; },
+			footer: function (currentPage, pageCount) { return 'footer: ' + currentPage.toString() + ' of ' + pageCount; },
+			background: function() { return { text:'SECTION 2 background', alignment: 'right' }; },
+			watermark: 'SECTION 2 watermark',
+			pageOrientation: 'landscape',
+			section: [
+				'SECTION 2',
+				'Text in section as landscape page.'
+			]
+		},
+		{
+			header: null,
+			footer: null,
+			background: null,
+			watermark: null,
+			pageSize: 'A7',
+			pageOrientation: 'portrait',
+			section: [
+				'SECTION 3',
+				'Text in section as A7 page.'
+			]
+		},
+		{
+			watermark: 'inherit',
+			pageSize: 'A6',
+			pageOrientation: 'portrait',
+			pageMargins: 5,
+			section: [
+				'SECTION 4',
+				'Text in section as A6 page with margin.'
+			]
+		},
+		{
+			watermark: 'watermark for inherit',
+			pageSize: 'A6',
+			pageOrientation: 'landscape',
+			pageMargins: 10,
+			section: [
+				'SECTION 5',
+				'Text in section as A6 landscape page with margin.'
+			]
+		},
+		{
+			watermark: 'inherit',
+			pageSize: 'inherit',
+			pageOrientation: 'inherit',
+			pageMargins: 'inherit',
+			section: [
+				'SECTION 6',
+				'Text in section with page definition as previous page. Page size, orientation and margins are inherited.'
+			]
+		},
+		{
+			header: function (currentPage, pageCount) { return 'header in section 8: ' + currentPage.toString() + ' of ' + pageCount; },
+			footer: function (currentPage, pageCount) { return 'footer in section 8: ' + currentPage.toString() + ' of ' + pageCount; },
+			section: [
+				'SECTION 7',
+				'Text in section with page definition as defined in document.'
+			]
+		}
+	]
+};
+
+var now = new Date();
+
+var pdf = pdfmake.createPdf(docDefinition);
+pdf.write('pdfs/sections.pdf').then(() => {
+	console.log(new Date() - now);
+}, err => {
+	console.error(err);
+});

src/DocMeasure.js

@@ -34,12 +34,18 @@ class DocMeasure {
 		return this.measureNode(docStructure);
 	}
 
+	measureBlock(node) {
+		return this.measureNode(node);
+	}
+
 	measureNode(node) {
 		return this.styleStack.auto(node, () => {
 			// TODO: refactor + rethink whether this is the proper way to handle margins
 			node._margin = getNodeMargin(node, this.styleStack);
 
-			if (node.columns) {
+			if (node.section) {
+				return extendMargins(this.measureSection(node));
+			} else if (node.columns) {
 				return extendMargins(this.measureColumns(node));
 			} else if (node.stack) {
 				return extendMargins(this.measureVerticalContainer(node));
@@ -465,6 +471,14 @@ class DocMeasure {
 		return node;
 	}
 
+	measureSection(node) {
+		// TODO: properties
+
+		node.section = this.measureNode(node.section);
+
+		return node;
+	}
+
 	measureColumns(node) {
 		let columns = node.columns;
 		node._gap = this.styleStack.getProperty('columnGap') || 0;

src/DocPreprocessor.js

@@ -20,10 +20,17 @@ class DocPreprocessor {
 		this.parentNode = null;
 		this.tocs = [];
 		this.nodeReferences = [];
-		return this.preprocessNode(docStructure);
+		return this.preprocessNode(docStructure, true);
 	}
 
-	preprocessNode(node) {
+	preprocessBlock(node) {
+		this.parentNode = null;
+		this.tocs = [];
+		this.nodeReferences = [];
+		return this.preprocessNode(node);
+	}
+
+	preprocessNode(node, isSectionAllowed = false) {
 		// expand shortcuts and casting values
 		if (Array.isArray(node)) {
 			node = { stack: node };
@@ -33,10 +40,16 @@ class DocPreprocessor {
 			node.text = convertValueToString(node.text);
 		}
 
-		if (node.columns) {
+		if (node.section) {
+			if (!isSectionAllowed) {
+				throw new Error(`Incorrect document structure, section node is only allowed at the root level of document structure: ${stringifyNode(node)}`);
+			}
+
+			return this.preprocessSection(node);
+		} else if (node.columns) {
 			return this.preprocessColumns(node);
 		} else if (node.stack) {
-			return this.preprocessVerticalContainer(node);
+			return this.preprocessVerticalContainer(node, isSectionAllowed);
 		} else if (node.ul) {
 			return this.preprocessList(node);
 		} else if (node.ol) {
@@ -64,6 +77,12 @@ class DocPreprocessor {
 		}
 	}
 
+	preprocessSection(node) {
+		node.section = this.preprocessNode(node.section);
+
+		return node;
+	}
+
 	preprocessColumns(node) {
 		let columns = node.columns;
 
@@ -74,11 +93,11 @@ class DocPreprocessor {
 		return node;
 	}
 
-	preprocessVerticalContainer(node) {
+	preprocessVerticalContainer(node, isSectionAllowed) {
 		let items = node.stack;
 
 		for (let i = 0, l = items.length; i < l; i++) {
-			items[i] = this.preprocessNode(items[i]);
+			items[i] = this.preprocessNode(items[i], isSectionAllowed);
 		}
 
 		return node;

src/DocumentContext.js

@@ -222,7 +222,7 @@ class DocumentContext extends EventEmitter {
 			let currentPageOrientation = this.getCurrentPage().pageSize.orientation;
 
 			let pageSize = getPageSize(this.getCurrentPage(), pageOrientation);
-			this.addPage(pageSize);
+			this.addPage(pageSize, null, this.getCurrentPage().customProperties);
 
 			if (currentPageOrientation === pageSize.orientation) {
 				this.availableWidth = currentAvailableWidth;
@@ -240,20 +240,20 @@ class DocumentContext extends EventEmitter {
 		};
 	}
 
-	addPage(pageSize, pageMargin = null) {
+	addPage(pageSize, pageMargin = null, customProperties = {}) {
 		if (pageMargin !== null) {
 			this.pageMargins = pageMargin;
 			this.x = pageMargin.left;
 			this.availableWidth = pageSize.width - pageMargin.left - pageMargin.right;
 		}
 
-		let page = { items: [], pageSize: pageSize, pageMargins: this.pageMargins };
+		let page = { items: [], pageSize: pageSize, pageMargins: this.pageMargins, customProperties: customProperties };
 		this.pages.push(page);
 		this.backgroundLength.push(0);
 		this.page = this.pages.length - 1;
 		this.initializePage();
 
-		this.emit('pageAdded');
+		this.emit('pageAdded', page);
 
 		return page;
 	}