Add pivot table with limitations #2551

mikez · 2023-10-09T05:30:46Z

worksheet.addPivotTable(configuration);

Note: Pivot table support is in its early stages with certain limitations, including:

No support for reading xlsx documents with existing pivot tables (writing is supported).
Pivot table configurations must consist of one "value" item and use the sum metric.
Only one pivot table can be added for the entire document.

Example usage

const workbook = new Excel.Workbook();

const worksheet1 = workbook.addWorksheet('Sheet1');
worksheet1.addRows([
  ['A', 'B', 'C', 'D', 'E'],
  ['a1', 'b1', 'c1', 4, 5],
  ['a1', 'b2', 'c1', 4, 5],
  ['a2', 'b1', 'c2', 14, 24],
  ['a2', 'b2', 'c2', 24, 35],
  ['a3', 'b1', 'c3', 34, 45],
  ['a3', 'b2', 'c3', 44, 45],
]);

const worksheet2 = workbook.addWorksheet('Sheet2');
worksheet2.addPivotTable({
  // Source data: entire sheet range
  sourceSheet: worksheet1,
  // Pivot table fields: via header row in `worksheet1`
  rows: ['A', 'B'],
  columns: ['C'],
  values: ['E'], // Exactly 1 field
  metric: 'sum', // Metric: 'sum' only
});

lib/doc/worksheet.js

Siemienik

Hello @mikez , Thank you for the latest changes, I'm really happy that Exceljs has possibility to gain new feature even with limitations.
I added few comments, I would be glad for answering that 😄

Good job and I love the direction when it comes. 🥇

Siemienik · 2023-10-23T21:13:37Z

lib/doc/pivot-table.js

+  if (!model.rows.length) {
+    throw new Error('No pivot table rows specified.');
+  }
+
+  if (!model.columns.length) {
+    throw new Error('No pivot table columns specified.');
+  }
+
+  if (model.values.length !== 1) {
+    throw new Error('Exactly 1 value needs to be specified at this time.');
+  }


Would It be enabled to add partially configured pivot table without for instance rows set?

At this time, the code doesn't support that. You need at least one item in each of {rows, columns, values}.
However, this could be a potential feature down the road if it is requested.

Siemienik · 2023-10-23T21:15:18Z

lib/doc/pivot-table.js

+  //    { name: 'E', sharedItems: null }
+  //  ]
+
+  const names = worksheet.getRow(1).values;


Does it always start from row 1?

I made the simplifying assumption that the source data is represented by the entire sheet, with the first row representing the header. Do you think this assumption is too simplistic and won't capture 95% of the cases?

Siemienik · 2023-10-23T21:21:51Z

lib/doc/worksheet.js

+    this.pivotTables.push(pivotTable);
+    this.workbook.pivotTables.push(pivotTable);


What will happen if someone remove the pivot table from one of these places, or overwrite one of them?
What do you think about making wb.workbook.pivotTables a getter returning pivottables from all worksheets? Or .. a function?
Can it attach one pivotTable to multiple sheets?

What will happen if someone remove the pivot table from one of these places, or overwrite one of them?

@Siemienik It seems you're pointing at the mutability of worksheet.pivotTables and worksheet.workbook.pivotTables and concerns for that clients might mutate this. If you think this type of safety is needed and consistent with elsewhere in ExcelJS, we can definitely make it a getter. I'll take your advice here.

Can it attach one pivotTable to multiple sheets?

At this time, I intend for there to be at most one pivotTable in at most one sheet across the entire workbook. The user should not have to mutate worksheet.pivotTables or worksheet.workbook.pivotTables and only access worksheet.addPivotTable.

lib/doc/pivot-table.js

lib/xlsx/xform/book/workbook-pivot-cache-xform.js

Siemienik · 2023-10-23T21:44:04Z

lib/xlsx/xform/pivot-table/pivot-table-xform.js

+    return `
+      <pivotField axis="${axis}" ${defaultAttributes}>
+        <items count="${sharedItems.length + 1}">
+          ${[...range(0, sharedItems.length)].map(index => `<item x="${index}" />`).join('\n              ')}


You may try this way:

Suggested change

${[...range(0, sharedItems.length)].map(index => `<item x="${index}" />`).join('\n ')}

${sharedItems.map((item, index) => `<item x="${index}" />`).join('\n ')}

Clever. I like this. I will update and force push this.

mikez · 2023-10-24T16:15:08Z

@Siemienik: I added few comments, I would be glad for answering that 😄

Thank you. Please guide me where I might want to add clarifications to the documentation or comments to make it clearer for other readers.

```js worksheet.addPivotTable(configuration); ``` **Note:** Pivot table support is in its early stages with certain limitations, including: - Xlsx files with existing pivot tables can't be read (writing is supported). - Pivot table configurations must have one "value"-item and use the "sum" metric. - Only one pivot table can be added for the entire document.

Siemienik

LGTM, thank you for booting up new feature into exceljs 👏

mikez · 2023-10-31T21:59:05Z

👉 Feedback and discussion here.

mikez force-pushed the master branch from f84aaf5 to ac94197 Compare October 9, 2023 05:33

mikez commented Oct 10, 2023

View reviewed changes

lib/doc/worksheet.js Outdated Show resolved Hide resolved

mikez force-pushed the master branch from ac94197 to a3d9929 Compare October 10, 2023 20:03

mikez force-pushed the master branch from a3d9929 to 347d3c6 Compare October 19, 2023 01:42

Siemienik reviewed Oct 23, 2023

View reviewed changes

mikez force-pushed the master branch from 347d3c6 to 7ead014 Compare October 24, 2023 16:13

mikez force-pushed the master branch from 7ead014 to bf8df05 Compare October 28, 2023 18:50

Siemienik approved these changes Oct 31, 2023

View reviewed changes

Siemienik added the hacktoberfest-accepted label Oct 31, 2023

mikez added 2 commits October 31, 2023 22:27

Merge remote-tracking branch 'origin/master'

7a08f6c

Update README

90ef90c

mikez force-pushed the master branch from 3b65b46 to 90ef90c Compare October 31, 2023 21:28

Merge branch 'master' into master

0413be9

Siemienik merged commit ddab279 into exceljs:master Oct 31, 2023
27 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add pivot table with limitations #2551

Add pivot table with limitations #2551

mikez commented Oct 9, 2023 •

edited

Siemienik left a comment

Siemienik Oct 23, 2023

mikez Oct 24, 2023

Siemienik Oct 23, 2023

mikez Oct 24, 2023 •

edited

Siemienik Oct 23, 2023

mikez Oct 24, 2023

Siemienik Oct 23, 2023

mikez Oct 24, 2023

mikez commented Oct 24, 2023

Siemienik left a comment

mikez commented Oct 31, 2023

		this.pivotTables.push(pivotTable);
		this.workbook.pivotTables.push(pivotTable);

	${[...range(0, sharedItems.length)].map(index => `<item x="${index}" />`).join('\n ')}
	${sharedItems.map((item, index) => `<item x="${index}" />`).join('\n ')}

Add pivot table with limitations #2551

Add pivot table with limitations #2551

Conversation

mikez commented Oct 9, 2023 • edited

Example usage

Siemienik left a comment

Choose a reason for hiding this comment

Siemienik Oct 23, 2023

Choose a reason for hiding this comment

mikez Oct 24, 2023

Choose a reason for hiding this comment

Siemienik Oct 23, 2023

Choose a reason for hiding this comment

mikez Oct 24, 2023 • edited

Choose a reason for hiding this comment

Siemienik Oct 23, 2023

Choose a reason for hiding this comment

mikez Oct 24, 2023

Choose a reason for hiding this comment

Siemienik Oct 23, 2023

Choose a reason for hiding this comment

mikez Oct 24, 2023

Choose a reason for hiding this comment

mikez commented Oct 24, 2023

Siemienik left a comment

Choose a reason for hiding this comment

mikez commented Oct 31, 2023

mikez commented Oct 9, 2023 •

edited

mikez Oct 24, 2023 •

edited