Merge pull request #1232 from Alanscut/issue_1131

Fix issue #1131 headerFooter property doesn't work with WorksheetWriter!

README.md

@@ -319,6 +319,17 @@ var sheet = workbook.addWorksheet('My Sheet', {views: [{showGridLines: false}]})
 
 // create a sheet with the first row and column frozen
 var sheet = workbook.addWorksheet('My Sheet', {views:[{state: 'frozen', xSplit: 1, ySplit:1}]});
+
+// Create worksheets with headers and footers
+var sheet = workbook.addWorksheet('My Sheet', {
+  headerFooter:{firstHeader: "Hello Exceljs", firstFooter: "Hello World"}
+});
+
+// create new sheet with pageSetup settings for A4 - landscape
+var worksheet =  workbook.addWorksheet('My Sheet', {
+  pageSetup:{paperSize: 9, orientation:'landscape'}
+});
+
 ```
 
 ## Remove a Worksheet [⬆](#contents)<!-- Link generated with jump2header -->
@@ -384,7 +395,7 @@ Worksheets support a property bucket to allow control over some features of the
 var worksheet = workbook.addWorksheet('sheet', {properties:{tabColor:{argb:'FF00FF00'}}});
 
 // create a new sheet writer with properties
-var worksheetWriter = workbookWriter.addSheet('sheet', {properties:{outlineLevelCol:1}});
+var worksheetWriter = workbookWriter.addWorksheet('sheet', {properties:{outlineLevelCol:1}});
 
 // adjust properties afterwards (not supported by worksheet-writer)
 worksheet.properties.outlineLevelCol = 2;
@@ -425,7 +436,7 @@ var worksheet =  workbook.addWorksheet('sheet', {
 });
 
 // create a new sheet writer with pageSetup settings for fit-to-page
-var worksheetWriter = workbookWriter.addSheet('sheet', {
+var worksheetWriter = workbookWriter.addWorksheet('sheet', {
   pageSetup:{fitToPage: true, fitToHeight: 5, fitToWidth: 7}
 });
 
@@ -500,6 +511,15 @@ In addition, you can set different texts for the first page and even page.
 Note: Images are not currently supported.
 
 ```javascript
+
+// Create worksheets with headers and footers
+var sheet = workbook.addWorksheet('sheet', {
+  headerFooter:{firstHeader: "Hello Exceljs", firstFooter: "Hello World"}
+});
+// Create worksheets with headers and footers
+var worksheetWriter = workbookWriter.addWorksheet('sheet', {
+  headerFooter:{firstHeader: "Hello Exceljs", firstFooter: "Hello World"}
+});
 // Set footer (default centered), result: "Page 2 of 16"
 worksheet.headerFooter.oddFooter = "Page &P of &N";
 

README_zh.md

@@ -295,8 +295,22 @@ var sheet = workbook.addWorksheet('My Sheet', {properties:{tabColor:{argb:'FFC00
 // 创建一个隐藏了网格线的工作表
 var sheet = workbook.addWorksheet('My Sheet', {views: [{showGridLines: false}]});
 
+// 创建一个第一行和列冻结的工作表
+var sheet = workbook.addWorksheet('My Sheet', {views:[{xSplit: 1, ySplit:1}]});
+
+// 使用A4设置的页面设置设置创建新工作表 - 横向
+var worksheet =  workbook.addWorksheet('My Sheet', {
+  pageSetup:{paperSize: 9, orientation:'landscape'}
+});
+
+// 创建一个具有页眉页脚的工作表
+var sheet = workbook.addWorksheet('My Sheet', {
+  headerFooter:{firstHeader: "Hello Exceljs", firstFooter: "Hello World"}
+});
+
 // 创建一个冻结了第一行和第一列的工作表
 var sheet = workbook.addWorksheet('My Sheet', {views:[{state: 'frozen', xSplit: 1, ySplit:1}]});
+
 ```
 
 ## 删除工作表
@@ -349,8 +363,8 @@ worksheet.state = 'veryHidden';
 // 创建具有属性的新工作表
 var worksheet = workbook.addWorksheet('sheet', {properties:{tabColor:{argb:'FF00FF00'}}});
 
-// 创建一个具有属性的新工作表读写器
-var worksheetWriter = workbookWriter.addSheet('sheet', {properties:{outlineLevelCol:1}});
+// 创建一个具有属性的可写的新工作表
+var worksheetWriter = workbookWriter.addWorksheet('sheet', {properties:{outlineLevelCol:1}});
 
 // 之后调整属性（工作表读写器不支持该操作）
 worksheet.properties.outlineLevelCol = 2;
@@ -390,8 +404,8 @@ var worksheet =  workbook.addWorksheet('sheet', {
   pageSetup:{paperSize: 9, orientation:'landscape'}
 });
 
-// 使用适用于页面的页面设置配置创建新的表格读写器
-var worksheetWriter = workbookWriter.addSheet('sheet', {
+// 使用适合页面的pageSetup设置创建一个新的工作表编写器
+var worksheetWriter = workbookWriter.addWorksheet('sheet', {
   pageSetup:{fitToPage: true, fitToHeight: 5, fitToWidth: 7}
 });
 
@@ -466,8 +480,18 @@ worksheet.pageSetup.printTitlesColumn = 'A:C';
 注意：目前不支持图片。
 
 ```javascript
-// 设置页脚（默认居中），结果：“第2页，共16页”
-worksheet.headerFooter.oddFooter = "Page &P of &N";
+// 创建一个带有页眉和页脚的工作表
+var sheet = workbook.addWorksheet('My Sheet', {
+  headerFooter:{firstHeader: "Hello Exceljs", firstFooter: "Hello World"}
+});
+
+// 创建一个带有页眉和页脚可写的工作表
+var worksheetWriter = workbookWriter.addWorksheet('sheet', {
+  headerFooter:{firstHeader: "Hello Exceljs", firstFooter: "Hello World"}
+});
+// 代码中出现的&开头字符对应变量，相关信息可查阅下文的变量表
+// 设置页脚(默认居中),结果：“第 2 页，共 16 页”
+worksheet.headerFooter.oddFooter = "第 &P 页，共 &N 页";
 
 // 将页脚（默认居中）设置为粗体，结果是：“第2页，共16页”
 worksheet.headerFooter.oddFooter = "Page &P of &N";

index.d.ts

@@ -971,7 +971,7 @@ export interface WorksheetModel {
 	// dataValidations: this.dataValidations.model,
 	properties: WorksheetProperties;
 	pageSetup: Partial<PageSetup>;
-	headerFooter: HeaderFooter;
+	headerFooter: Partial<HeaderFooter>;
 	rowBreaks: RowBreak[];
 	views: WorksheetView[];
 	autoFilter: AutoFilter;
@@ -983,12 +983,12 @@ export type CellIsOperators = 'equal' | 'greaterThan' | 'lessThan' | 'between';
 
 export type ContainsTextOperators = 'containsText' | 'containsBlanks' | 'notContainsBlanks' | 'containsErrors' | 'notContainsErrors';
 
-export type TimePeriodTypes = 'lastWeek' | 'thisWeek' | 'nextWeek' | 'yesterday' | 'today' | 'tomorrow' | 'last7Days' | 'lastMonth' 
-			| 'thisMonth' | 'nextMonth';
+export type TimePeriodTypes = 'lastWeek' | 'thisWeek' | 'nextWeek' | 'yesterday' | 'today' | 'tomorrow' | 'last7Days' | 'lastMonth'
+	| 'thisMonth' | 'nextMonth';
 
-export type IconSetTypes = '5Arrows' | '5ArrowsGray' | '5Boxes' | '5Quarters' | '5Rating' | '4Arrows' | '4ArrowsGray' 
-			| '4Rating' | '4RedToBlack' | '4TrafficLights' | 'NoIcons' | '3Arrows' | '3ArrowsGray' | '3Flags' | '3Signs' 
-			| '3Stars' | '3Symbols' | '3Symbols2' | '3TrafficLights1' | '3TrafficLights2' | '3Triangles';
+export type IconSetTypes = '5Arrows' | '5ArrowsGray' | '5Boxes' | '5Quarters' | '5Rating' | '4Arrows' | '4ArrowsGray'
+	| '4Rating' | '4RedToBlack' | '4TrafficLights' | 'NoIcons' | '3Arrows' | '3ArrowsGray' | '3Flags' | '3Signs'
+	| '3Stars' | '3Symbols' | '3Symbols2' | '3TrafficLights1' | '3TrafficLights2' | '3Triangles';
 
 export type CfvoTypes = 'percentile' | 'percent' | 'num' | 'min' | 'max' | 'formula' | 'autoMin' | 'autoMax';
 
@@ -1063,13 +1063,13 @@ export interface DataBarRuleType extends ConditionalFormattingBaseRule {
 	cfvo?: Cvfo[];
 }
 
-export type ConditionalFormattingRule = ExpressionRuleType | CellIsRuleType | Top10RuleType | AboveAverageRuleType | ColorScaleRuleType | IconSetRuleType 
-				| ContainsTextRuleType | TimePeriodRuleType | DataBarRuleType;
+export type ConditionalFormattingRule = ExpressionRuleType | CellIsRuleType | Top10RuleType | AboveAverageRuleType | ColorScaleRuleType | IconSetRuleType
+	| ContainsTextRuleType | TimePeriodRuleType | DataBarRuleType;
 
 export interface ConditionalFormattingOptions {
 	ref: string;
 	rules: ConditionalFormattingRule[];
-} 
+}
 
 export interface Worksheet {
 	readonly id: number;
@@ -1086,7 +1086,7 @@ export interface Worksheet {
 	/**
 	 * Worksheet Header and Footer
 	 */
-	headerFooter: HeaderFooter;
+	headerFooter: Partial<HeaderFooter>;
 
 	/**
 	 * Worksheet State
@@ -1282,7 +1282,7 @@ export interface Worksheet {
 	 * Using the image id from `Workbook.addImage`,
 	 * embed an image within the worksheet to cover a range
 	 */
-	addImage(imageId: number, range: string | { editAs?: string; } & ImageRange & {hyperlinks?: ImageHyperlinkValue} | { editAs?: string; } & ImagePosition & {hyperlinks?: ImageHyperlinkValue}): void;
+	addImage(imageId: number, range: string | { editAs?: string; } & ImageRange & { hyperlinks?: ImageHyperlinkValue } | { editAs?: string; } & ImagePosition & { hyperlinks?: ImageHyperlinkValue }): void;
 
 	getImages(): Array<{
 		type: 'image',
@@ -1370,6 +1370,7 @@ export interface WorksheetProperties {
 export interface AddWorksheetOptions {
 	properties: Partial<WorksheetProperties>;
 	pageSetup: Partial<PageSetup>;
+	headerFooter: Partial<HeaderFooter>;
 	views: Array<Partial<WorksheetView>>;
 	state: WorksheetState;
 }
@@ -1860,42 +1861,42 @@ export namespace stream {
 			useStyles: boolean;
 		}
 
-        interface ArchiverZipOptions {
-            comment: string;
-            forceLocalTime: boolean;
-            forceZip64: boolean;
-            store: boolean;
-            zlib: Partial<ZlibOptions>;
-        }
-
-        interface ZlibOptions {
-            /**
-             * @default constants.Z_NO_FLUSH
-             */
-            flush: number;
-            /**
-             * @default constants.Z_FINISH
-             */
-            finishFlush: number;
-            /**
-             * @default 16*1024
-             */
-            chunkSize: number;
-            windowBits: number;
-            level: number; // compression only
-            memLevel: number; // compression only
-            strategy: number; // compression only
-            dictionary: Buffer | NodeJS.TypedArray | DataView | ArrayBuffer; // deflate/inflate only, empty dictionary by default
-        }
+		interface ArchiverZipOptions {
+			comment: string;
+			forceLocalTime: boolean;
+			forceZip64: boolean;
+			store: boolean;
+			zlib: Partial<ZlibOptions>;
+		}
+
+		interface ZlibOptions {
+			/**
+			 * @default constants.Z_NO_FLUSH
+			 */
+			flush: number;
+			/**
+			 * @default constants.Z_FINISH
+			 */
+			finishFlush: number;
+			/**
+			 * @default 16*1024
+			 */
+			chunkSize: number;
+			windowBits: number;
+			level: number; // compression only
+			memLevel: number; // compression only
+			strategy: number; // compression only
+			dictionary: Buffer | NodeJS.TypedArray | DataView | ArrayBuffer; // deflate/inflate only, empty dictionary by default
+		}
 
 		interface WorkbookStreamWriterOptions extends WorkbookWriterOptions {
 
-            /**
-             * Specifies whether to add style information to the workbook.
-             * Styles can add some performance overhead. Default is false
-             */
-            zip: Partial<ArchiverZipOptions>;
-        }
+			/**
+			 * Specifies whether to add style information to the workbook.
+			 * Styles can add some performance overhead. Default is false
+			 */
+			zip: Partial<ArchiverZipOptions>;
+		}
 
 		class WorkbookWriter extends Workbook {
 			constructor(options: Partial<WorkbookStreamWriterOptions>);

lib/doc/worksheet.js

@@ -1,6 +1,6 @@
 const _ = require('../utils/under-dash');
 
-const colCache = require('./../utils/col-cache');
+const colCache = require('../utils/col-cache');
 const Range = require('./range');
 const Row = require('./row');
 const Column = require('./column');
@@ -89,16 +89,20 @@ class Worksheet {
       options.pageSetup
     );
 
-    this.headerFooter = {
-      differentFirst: false,
-      differentOddEven: false,
-      oddHeader: null,
-      oddFooter: null,
-      evenHeader: null,
-      evenFooter: null,
-      firstHeader: null,
-      firstFooter: null,
-    };
+    this.headerFooter = Object.assign(
+      {},
+      {
+        differentFirst: false,
+        differentOddEven: false,
+        oddHeader: null,
+        oddFooter: null,
+        evenHeader: null,
+        evenFooter: null,
+        firstHeader: null,
+        firstFooter: null,
+      },
+      options.headerFooter
+    );
 
     this.dataValidations = new DataValidations();
 
@@ -564,6 +568,7 @@ class Worksheet {
       if (Array.isArray(results[0])) {
         getResult = (row, col) => results[row - top][col - left];
       } else {
+        // eslint-disable-next-line no-mixed-operators
         getResult = (row, col) => results[(row - top) * width + (col - left)];
       }
     } else {
@@ -631,7 +636,7 @@ class Worksheet {
       };
       if (options && 'spinCount' in options) {
         // force spinCount to be integer >= 0
-        options.spinCount = isFinite(options.spinCount) ? Math.round(Math.max(0, options.spinCount)) : 100000;
+        options.spinCount = Number.isFinite(options.spinCount) ? Math.round(Math.max(0, options.spinCount)) : 100000;
       }
       if (password) {
         this.sheetProtection.algorithmName = 'SHA-512';

lib/stream/xlsx/workbook-writer.js

@@ -157,6 +157,7 @@ class WorkbookWriter {
       pageSetup: options.pageSetup,
       views: options.views,
       autoFilter: options.autoFilter,
+      headerFooter: options.headerFooter,
     });
 
     this._worksheets[id] = worksheet;

lib/stream/xlsx/worksheet-writer.js

@@ -31,6 +31,7 @@ const PageSetupXform = require('../../xlsx/xform/sheet/page-setup-xform');
 const AutoFilterXform = require('../../xlsx/xform/sheet/auto-filter-xform');
 const PictureXform = require('../../xlsx/xform/sheet/picture-xform');
 const ConditionalFormattingsXform = require('../../xlsx/xform/sheet/cf/conditional-formattings-xform');
+const HeaderFooterXform = require('../../xlsx/xform/sheet/header-footer-xform');
 const RowBreaksXform = require('../../xlsx/xform/sheet/row-breaks-xform');
 
 // since prepare and render are functional, we can use singletons
@@ -48,6 +49,7 @@ const xform = {
   autoFilter: new AutoFilterXform(),
   picture: new PictureXform(),
   conditionalFormattings: new ConditionalFormattingsXform(),
+  headerFooter: new HeaderFooterXform(),
   rowBreaks: new RowBreaksXform(),
 };
 
@@ -117,6 +119,21 @@ class WorksheetWriter {
       options.properties
     );
 
+    this.headerFooter = Object.assign(
+      {},
+      {
+        differentFirst: false,
+        differentOddEven: false,
+        oddHeader: null,
+        oddFooter: null,
+        evenHeader: null,
+        evenFooter: null,
+        firstHeader: null,
+        firstFooter: null,
+      },
+      options.headerFooter
+    );
+
     // for all things printing
     this.pageSetup = Object.assign(
       {},
@@ -219,6 +236,7 @@ class WorksheetWriter {
     this._writePageMargins();
     this._writePageSetup();
     this._writeBackground();
+    this._writeHeaderFooter();
     this._writeRowBreaks();
 
     // Legacy Data tag for comments
@@ -434,7 +452,6 @@ class WorksheetWriter {
   }
 
   removeConditionalFormatting(filter) {
-    console.log('conditionalFormatting', this.conditionalFormatting);
     if (typeof filter === 'number') {
       this.conditionalFormatting.splice(filter, 1);
     } else if (filter instanceof Function) {
@@ -606,6 +623,10 @@ class WorksheetWriter {
     this.stream.write(xform.pageSeteup.toXml(this.pageSetup));
   }
 
+  _writeHeaderFooter() {
+    this.stream.write(xform.headerFooter.toXml(this.headerFooter));
+  }
+
   _writeAutoFilter() {
     this.stream.write(xform.autoFilter.toXml(this.autoFilter));
   }