PivotTables support serialization/deserialization.
The SerializeInfo returned by the serialize() API can only be used in pivot tables under the same data source.
Serialize & Deserialize
Serialization supports the following data:
Fields, Options, Filter, Sort, Layout, PivotTable Position, Theme
ISerializeInfo Interface
API
Sample Code
import * as React from 'react';
import { createRoot } from 'react-dom/client';
import './styles.css';
import { AppFunc } from './app-func';
// 1. Functional Component sample
createRoot(document.getElementById('app')).render(<AppFunc />);
import * as React from 'react';
import GC from '@mescius/spread-sheets';
import "@mescius/spread-sheets-shapes";
import "@mescius/spread-sheets-pivot-addon";
import { SpreadSheets, Worksheet } from '@mescius/spread-sheets-react';
import './styles.css';
const useState = React.useState;
let pt;
export const AppFunc = () => {
const [serializeInfo, setSerializeInfo] = useState('');
return (
<div className="sample-tutorial">
<div className="sample-spreadsheets">
<SpreadSheets workbookInitialized={spread => initSpread(spread)}>
<Worksheet>
</Worksheet>
<Worksheet>
</Worksheet>
</SpreadSheets>
</div>
<div className="sample-panel">
<div id="panel"></div>
</div>
<div id="container" class="options-container">
<span><u>Serialize Info:</u></span>
<br />
<div class="option-row">Click the <b>Serialize</b> button to save the current state/view of the pivot table data.</div>
<div class="option-row">You can make further changes to the pivot table fields, and click <b>Deserialize</b> to restore the original data view.</div>
<br />
<input type="button" value="Serialize" class="set-option" id="Serialize" onClick={() => { serialize(setSerializeInfo) }} />
<input type="button" value="Deserialize" class="set-option" id="Deserialize" onClick={() => { deserialize(serializeInfo) }} />
<br /><br />
<textarea name="serializeInfo" id="serializeInfo" cols="30" rows="50" value={serializeInfo} onChange={(e) => { setTextareaValue(e, setSerializeInfo) }}></textarea>
</div>
</div>
);
}
function setTextareaValue(e, setSerializeInfo) {
setSerializeInfo(e.target.value);
}
function initSpread(spread) {
initSheets(spread);
let pivotLayoutSheet = spread.getSheet(0);
pt = initPivotTable(pivotLayoutSheet);
}
function initSheets(spread) {
spread.suspendPaint();
let sheet = spread.getSheet(1);
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('tableSales', 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, pivotSales);
let sheet0 = spread.getSheet(0);
sheet0.name("PivotLayout");
spread.resumePaint();
}
function initPivotTable(sheet) {
let myPivotTable = sheet.pivotTables.add("myPivotTable", "tableSales", 1, 1, GC.Spread.Pivot.PivotTableLayoutType.outline, GC.Spread.Pivot.PivotTableThemes.light1);
myPivotTable.suspendLayout();
myPivotTable.options.showRowHeader = true;
myPivotTable.options.showColumnHeader = true;
myPivotTable.add("salesperson", "Salesperson", GC.Spread.Pivot.PivotTableFieldType.rowField);
myPivotTable.add("car", "Cars", GC.Spread.Pivot.PivotTableFieldType.rowField);
let groupInfo = { originFieldName: "date", dateGroups: [{ by: GC.Pivot.DateGroupType.quarters }] };
myPivotTable.group(groupInfo);
myPivotTable.add("Quarters (date)", "Quarters (date)", GC.Spread.Pivot.PivotTableFieldType.columnField);
myPivotTable.add("total", "Totals", GC.Spread.Pivot.PivotTableFieldType.valueField, GC.Pivot.SubtotalType.sum);
let itemList = ["Alan", "John", "Tess"];
myPivotTable.labelFilter("Salesperson", { textItem: { list: itemList, isAll: false } });
let carList = ["Audi", "BMW", "Mercedes"];
myPivotTable.labelFilter("Cars", { textItem: { list: carList, isAll: false } });
let panel = new GC.Spread.Pivot.PivotPanel("myPivotPanel", myPivotTable, document.getElementById("panel"));
panel.sectionVisibility(GC.Spread.Pivot.PivotPanelSection.fields + GC.Spread.Pivot.PivotPanelSection.area);
myPivotTable.resumeLayout();
myPivotTable.autoFitColumn();
return myPivotTable;
}
function serialize(setSerializeInfo) {
let ptInfo = pt.serialize();
setSerializeInfo(JSON.stringify(ptInfo, null, 2));
}
function deserialize(serializeInfo) {
try {
let info = JSON.parse(serializeInfo);
pt.deserialize(info);
} catch (e) {
alert("invalid serialize info!");
}
}
<!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"></div>
</body>
</html>
.sample-tutorial {
position: relative;
height: 100%;
}
.sample-spreadsheets {
width: calc(100% - 600px);
height: 100%;
overflow: hidden;
display: inline-block;
}
body {
position: absolute;
top: 0;
bottom: 0;
left: 0;
right: 0;
overflow: hidden;
}
.sample-panel {
width: 292px;
padding: 1px;
height: 100%;
box-sizing: border-box;
background: #fbfbfb;
overflow: auto;
display: inline-block;
}
.gc-panel {
padding: 10px;
background-color: rgb(230, 230, 230);
}
#panel {
right: 0;
width: 292px;
height: 100%;
top: 0;
}
#app {
height: 100%;
}
.options-container {
width: 292px;
padding: 1px;
height: 100%;
box-sizing: border-box;
background: #fbfbfb;
overflow: auto;
display: inline-block;
}
.option-row {
font-size: 14px;
padding: 5px;
margin-top: 10px;
}
div > textarea {
overflow: scroll;
width: 100%;
height: calc(100% - 100px);
outline: none;
box-sizing: border-box;
}
div > span {
display: inline-block;
margin: 5px;
white-space: pre;
}
(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/cjs/react.production.js',
'react-dom': 'npm:react-dom/cjs/react-dom.production.js',
'react-dom/client': 'npm:react-dom/cjs/react-dom-client.production.js',
'scheduler': 'npm:scheduler/cjs/scheduler.production.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);
