PivotTable Collapse

SpreadJS allows you to use collapsing operations on fields in rows/columns in a pivot table, which allows for a clearer presentation of the data.

Description
app.vue
index.html
Copy to CodeMine

In a PivotTable, users can collapse different fields. For example: Group order dates by year and month, or group test scores in bands of 10.

Users can collapse any field in the rows/columns, which gives a quick view of the statistics.

///* function collapse(fieldName: string, item: string, isCollapse?: boolean): boolean | void
/**
 * @param {string} fieldName Indicates the target field name.
* @param {string} item Indicates the collapse item name.
* @param {boolean} [isCollapse] Indicates the status of the collapse.
* @returns {boolean|void} whether is collapsed.
 */
collapse (fieldName: string, item: string, isCollapse?: boolean): void;
pivotTable.collapse("Salesperson", "Alan", true);
  • Users can expand or collapse a specific item in a pivot field, and see only its heading. The other items in that field will not be affected.
In a PivotTable, users can collapse different fields. For example: Group order dates by year and month, or group test scores in bands of 10. Users can collapse any field in the rows/columns, which gives a quick view of the statistics. Users can expand or collapse a specific item in a pivot field, and see only its heading. The other items in that field will not be affected.
<template> <div class="sample-tutorial"> <gc-spread-sheets class="sample-spreadsheets" @workbookInitialized="initSpread" > </gc-spread-sheets> <div class="options-container"> <div class="collapse-header"> <label><b>collapse fields</b></label> </div> <hr /> <div class='collapse' v-for="item in itemsRef" :key="item.id"> <input type='checkbox' :class='item.class' v-model.lazy="item.checked" @click="updatePivot(item.id)"/> <label :for='item.id'> {{item.text}} </label> </div> </div> </div> </template> <script setup> import GC from "@mescius/spread-sheets"; import "@mescius/spread-sheets-shapes"; import "@mescius/spread-sheets-vue"; import { shallowRef } from "vue"; import "@mescius/spread-sheets-pivot-addon"; let autoGenerateColumnsRef = shallowRef(false); let autoMergeModeRef = shallowRef(GC.Spread.Sheets.AutoMerge.AutoMergeMode.restricted); let autoMergeSelectionModeRef = shallowRef(GC.Spread.Sheets.AutoMerge.SelectionMode.merged); let spreadRef = shallowRef(null); let itemsRef = shallowRef([{ id: "collapse-region", parentClass: "collapse", class: "collapse-region", text: "Collapse Salesperson field", checked: false, }]); async function initSpread(spread) { spreadRef.value = spread; spread.setSheetCount(2); spread.suspendPaint(); let sheet1 = spread.getSheet(0); let sheet2 = spread.getSheet(1); let tableName = getDataSource(sheet2, pivotSales); addPivotTable(sheet1, tableName); spread.resumePaint(); } function getDataSource (sheet, tableSource) { sheet.name("DataSource"); sheet.setRowCount(117); sheet.setColumnWidth(0, 120); sheet.getCell(-1, 0).formatter("YYYY-mm-DD"); sheet.getRange(-1, 4, 0, 2).formatter("$ #,##0"); let table = sheet.tables.add("table", 0, 0, 117, 6); for (let i = 2; i <= 117; i++) { sheet.setFormula(i - 1, 5, "=D" + i + "*E" + i); } table.style(GC.Spread.Sheets.Tables.TableThemes["none"]); sheet.setArray(0, 0, tableSource); return table.name(); } function addPivotTable (sheet, source) { sheet.suspendPaint(); sheet.name("PivotTable"); sheet.setRowCount(10000); let pivotTable = sheet.pivotTables.add( "PivotTable", source, 1, 1, GC.Spread.Pivot.PivotTableLayoutType.outline, GC.Spread.Pivot.PivotTableThemes.light8 ); pivotTable.suspendLayout(); pivotTable.add( "salesperson", "Salesperson", GC.Spread.Pivot.PivotTableFieldType.rowField ); pivotTable.add( "car", "Cars", GC.Spread.Pivot.PivotTableFieldType.rowField ); let groupInfo = { originFieldName: "date", dateGroups: [ { by: GC.Pivot.DateGroupType.quarters }, ], }; pivotTable.group(groupInfo); pivotTable.add( "Quarters (date)", "Quarters (date)", GC.Spread.Pivot.PivotTableFieldType.columnField ); pivotTable.add( "total", "Totals", GC.Spread.Pivot.PivotTableFieldType.valueField, GC.Pivot.SubtotalType.sum ); pivotTable.resumeLayout(); sheet.resumePaint(); pivotTable.autoFitColumn(); } function updatePivot (text) { let spread = spreadRef.value; let pivotTable = spread.getActiveSheet().pivotTables.get("PivotTable"); switch (text) { case "collapse-region": spread.suspendPaint(); let isCollapse = false; if (!itemsRef.value[0].checked) { isCollapse = true; } pivotTable.collapse("Salesperson", "Alan", isCollapse); pivotTable.collapse("Salesperson", "Bob", isCollapse); pivotTable.collapse("Salesperson", "John", isCollapse); pivotTable.collapse("Salesperson", "Serena", isCollapse); pivotTable.collapse("Salesperson", "Tess", isCollapse); spread.resumePaint(); break; } } </script> <style scoped> .sample-tutorial { position: relative; height: 100%; overflow: hidden; } .sample-spreadsheets { width: calc(100% - 280px); height: 100%; overflow: hidden; float: left; } .options-container { float: right; width: 280px; padding: 12px; height: 100%; box-sizing: border-box; background: #fbfbfb; overflow: auto; font-size: 14px; } body { position: absolute; top: 0; bottom: 0; left: 0; right: 0; } .collapse-header{ width: 250px; margin-bottom: 20px; } .collapse { width: 250px; margin-top: 20px; } select{ width: 250px; } #app { height: 100%; } </style>
<!DOCTYPE html> <html style="height:100%;font-size:14px;"> <head> <meta charset="utf-8" /> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <title>SpreadJS VUE</title> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <link rel="stylesheet" type="text/css" href="$DEMOROOT$/en/vue3/node_modules/@mescius/spread-sheets/styles/gc.spread.sheets.excel2013white.css"> <script src="$DEMOROOT$/spread/source/data/pivot-data.js" type="text/javascript"></script> <script src="$DEMOROOT$/en/vue3/node_modules/systemjs/dist/system.src.js"></script> <script src="./systemjs.config.js"></script> <script src="./compiler.js" type="module"></script> <script> var System = SystemJS; System.import("./src/app.js"); System.import('$DEMOROOT$/en/lib/vue3/license.js'); </script> </head> <body> <div id="app"></div> </body> </html>
(function (global) { SystemJS.config({ transpiler: 'plugin-babel', babelOptions: { es2015: true }, paths: { // paths serve as alias 'npm:': 'node_modules/' }, packageConfigPaths: [ '../node_modules/*/package.json', "../node_modules/@mescius/*/package.json", "../node_modules/@babel/*/package.json", "../node_modules/@vue/*/package.json" ], map: { 'vue': "npm:vue/dist/vue.esm-browser.js", 'tiny-emitter': 'npm:tiny-emitter/index.js', 'plugin-babel': 'npm:systemjs-plugin-babel/plugin-babel.js', "systemjs-babel-build": "npm:systemjs-plugin-babel/systemjs-babel-browser.js", '@mescius/spread-sheets': 'npm:@mescius/spread-sheets/index.js', '@mescius/spread-sheets-resources-en': 'npm:@mescius/spread-sheets-resources-en/index.js', '@mescius/spread-sheets-vue': 'npm:@mescius/spread-sheets-vue/index.js', '@mescius/spread-sheets-pivot-addon': 'npm:@mescius/spread-sheets-pivot-addon/index.js', '@mescius/spread-sheets-shapes': 'npm:@mescius/spread-sheets-shapes/index.js' }, meta: { '*.css': { loader: 'systemjs-plugin-css' }, '*.vue': { loader: "../plugin-vue/index.js" } } }); })(this);