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.jsx
app-func.jsx
app-class.jsx
index.html
styles.css
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.
import * as React from 'react'; import * as ReactDOM from 'react-dom'; import './styles.css'; import { AppFunc } from './app-func'; import { App } from './app-class'; // 1. Functional Component sample ReactDOM.render(<AppFunc />, document.getElementById('app')); // 2. Class Component sample // ReactDOM.render(<App />, document.getElementById('app'));
import * as React from 'react'; import GC from '@mescius/spread-sheets'; import "@mescius/spread-sheets-shapes"; import "@mescius/spread-sheets-pivot-addon"; import { SpreadSheets } from '@mescius/spread-sheets-react'; import './styles.css'; const useState = React.useState; export function AppFunc() { const [collapsed, setCollapsed] = useState(false); const [spread, setSpread] = useState(null); const [pivotTable, setPivotTable] = useState(null); const handleCollapsed = (event) => { spread.suspendPaint(); let isCollapse = false; if (event.target.checked) { isCollapse = true; } setCollapsed(event.target.checked); 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(); } const initSpread = (spread) => { spread.setSheetCount(2); spread.suspendPaint(); setSpread(spread); let sheet1 = spread.getSheet(0); let sheet2 = spread.getSheet(1); let tableName = getSource(sheet2, pivotSales); let pivotTable = addPivotTable(sheet1, tableName); setPivotTable(pivotTable); spread.resumePaint(); } const getSource = (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(); } const addPivotTable = (sheet, source) => { sheet.suspendPaint(); sheet.name("PivotTable"); sheet.setRowCount(10000); let pt = sheet.pivotTables.add("PivotTable", source, 1, 1, GC.Spread.Pivot.PivotTableLayoutType.outline, GC.Spread.Pivot.PivotTableThemes.light8); pt.suspendLayout(); pt.add("salesperson", "Salesperson", GC.Spread.Pivot.PivotTableFieldType.rowField); pt.add("car", "Cars", GC.Spread.Pivot.PivotTableFieldType.rowField); let groupInfo = { originFieldName: "date", dateGroups: [{ by: GC.Pivot.DateGroupType.quarters }] }; pt.group(groupInfo); pt.add("Quarters (date)", "Quarters (date)", GC.Spread.Pivot.PivotTableFieldType.columnField); pt.add("total", "Totals", GC.Spread.Pivot.PivotTableFieldType.valueField, GC.Pivot.SubtotalType.sum); pt.resumeLayout(); sheet.resumePaint(); pt.autoFitColumn(); return pt; } return ( <div class="sample-tutorial"> <div class="sample-spreadsheets"> <SpreadSheets workbookInitialized={spread => initSpread(spread)}> </SpreadSheets> </div> <div class="options-container"> <div class="collapse-header"> <label><b>collapse fields</b></label> </div> <hr /> <div class="collapse"> <input type="checkbox" id="collapse-region" class="collapse-region" checked={collapsed} onClick={handleCollapsed}></input> <label for="collapse-region">Collapse <b>Salesperson</b> field</label> </div> </div> </div> ); }
import * as React from 'react'; import GC from '@mescius/spread-sheets'; import "@mescius/spread-sheets-shapes"; import "@mescius/spread-sheets-pivot-addon"; import { SpreadSheets } from '@mescius/spread-sheets-react'; import './styles.css'; const Component = React.Component; export class App extends Component { constructor(props) { super(props); this.state = { collapsed: false } this.handleCollapsed = this.handleCollapsed.bind(this); } handleCollapsed(event) { let spread = this.spread, pivotTable = this.pivotTable; spread.suspendPaint(); let isCollapse = false; if (event.target.checked) { isCollapse = true; } this.setState({ collapsed: event.target.checked }); 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(); } render() { return ( <div class="sample-tutorial"> <div class="sample-spreadsheets"> <SpreadSheets workbookInitialized={spread => this.initSpread(spread)}> </SpreadSheets> </div> <div class="options-container"> <div class="collapse-header"> <label><b>collapse fields</b></label> </div> <hr /> <div class="collapse"> <input type="checkbox" id="collapse-region" class="collapse-region" checked={this.state.collapsed} onClick={this.handleCollapsed}></input> <label for="collapse-region">Collapse <b>Salesperson</b> field</label> </div> </div> </div> ); } initSpread(spread) { spread.setSheetCount(2); spread.suspendPaint(); this.spread = spread; let sheet1 = spread.getSheet(0); let sheet2 = spread.getSheet(1); let tableName = this.getSource(sheet2, pivotSales); let pivotTable = this.addPivotTable(sheet1, tableName); this.pivotTable = pivotTable; spread.resumePaint(); } getSource(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(); } 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(); return pivotTable; } }
<!doctype html> <html style="height:100%;font-size:14px;"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <link rel="stylesheet" type="text/css" href="$DEMOROOT$/en/react/node_modules/@mescius/spread-sheets/styles/gc.spread.sheets.excel2013white.css"> <script src="$DEMOROOT$/spread/source/data/pivot-data.js" type="text/javascript"></script> <!-- SystemJS --> <script src="$DEMOROOT$/en/react/node_modules/systemjs/dist/system.src.js"></script> <script src="systemjs.config.js"></script> <script> System.import('$DEMOROOT$/en/lib/react/license.js').then(function () { System.import('./src/app'); }); </script> </head> <body> <div id="app" style="height: 100%;"></div> </body> </html>
.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; } 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; }
(function (global) { System.config({ transpiler: 'plugin-babel', babelOptions: { es2015: true, react: true }, meta: { '*.css': { loader: 'css' } }, paths: { // paths serve as alias 'npm:': 'node_modules/' }, // map tells the System loader where to look for things map: { '@mescius/spread-sheets': 'npm:@mescius/spread-sheets/index.js', '@mescius/spread-sheets-shapes': 'npm:@mescius/spread-sheets-shapes/index.js', '@mescius/spread-sheets-pivot-addon': 'npm:@mescius/spread-sheets-pivot-addon/index.js', '@mescius/spread-sheets-react': 'npm:@mescius/spread-sheets-react/index.js', '@grapecity/jsob-test-dependency-package/react-components': 'npm:@grapecity/jsob-test-dependency-package/react-components/index.js', 'react': 'npm:react/umd/react.production.min.js', 'react-dom': 'npm:react-dom/umd/react-dom.production.min.js', 'css': 'npm:systemjs-plugin-css/css.js', 'plugin-babel': 'npm:systemjs-plugin-babel/plugin-babel.js', 'systemjs-babel-build':'npm:systemjs-plugin-babel/systemjs-babel-browser.js' }, // packages tells the System loader how to load when no filename and/or no extension packages: { src: { defaultExtension: 'jsx' }, "node_modules": { defaultExtension: 'js' }, } }); })(this);