概述
本 Demo 展示了 SpreadJS 工作簿的 JSON 序列化和反序列化功能。Demo 创建了一个包含数据透视表、样式和公式的复杂工作簿,然后通过 toJSON 方法将其序列化为 JSON 字符串,再通过 fromJSON 方法反序列化到另一个工作簿中。Demo 还提供了丰富的选项来控制序列化和反序列化的行为。
实现思路
创建两个 Spread 实例,第一个用于展示原始数据,第二个用于接收反序列化后的数据
在第一个 Spread 中初始化三个工作表:一个带样式和公式的销售数据表、一个数据透视表源数据表、一个数据透视表
提供复选框让用户选择序列化和反序列化的选项
点击按钮时,将第一个 Spread 序列化为 JSON,然后反序列化到第二个 Spread
代码解析
序列化选项配置
这段代码配置了序列化选项。ignoreFormula 控制是否忽略公式,ignoreStyle 控制是否忽略样式,rowHeadersAsFrozenColumns 将行标题视为冻结列,columnHeadersAsFrozenRows 将列标题视为冻结行。
序列化工作簿
使用 toJSON 方法将工作簿序列化为 JSON 对象,然后使用 JSON.stringify 转换为字符串。
反序列化选项配置
反序列化选项除了 ignoreFormula 和 ignoreStyle 外,还支持 frozenColumnsAsRowHeaders(将冻结列视为行标题)、frozenRowsAsColumnHeaders(将冻结行视为列标题)以及 doNotRecalculateAfterLoad(加载后避免重新计算)。
反序列化工作簿
使用 JSON.parse 将 JSON 字符串解析为对象,然后通过 fromJSON 方法加载到目标工作簿中。
运行效果
页面上方显示包含多个工作表的原始 Spread 实例
页面下方显示空的目标 Spread 实例
右侧面板提供两组选项:ToJSON 选项和 FromJSON 选项
勾选不同的选项后点击"JSON 序列化"按钮,可以看到第一个 Spread 的内容被复制到第二个 Spread
不同的选项会影响序列化结果,例如勾选"忽略样式"后,第二个 Spread 将不会显示样式
API 参考
toJSON 方法
将工作簿对象序列化为 JSON 对象。
serializationOption.ignoreFormula:可选,是否忽略公式,默认为 false
serializationOption.ignoreStyle:可选,是否忽略样式,默认为 false
serializationOption.rowHeadersAsFrozenColumns:可选,是否将行标题视为冻结列,默认为 false
serializationOption.columnHeadersAsFrozenRows:可选,是否将列标题视为冻结行,默认为 false
serializationOption.includeBindingSource:可选,是否包含绑定源,默认为 false
serializationOption.saveAsView:可选,是否包含格式字符串的格式化结果,默认为 false
fromJSON 方法
从 JSON 对象反序列化工作簿。
json:要反序列化的 JSON 对象
deserializationOptions.ignoreFormula:可选,是否忽略公式,默认为 false
deserializationOptions.ignoreStyle:可选,是否忽略样式,默认为 false
deserializationOptions.frozenColumnsAsRowHeaders:可选,是否将冻结列视为行标题,默认为 false
deserializationOptions.frozenRowsAsColumnHeaders:可选,是否将冻结行视为列标题,默认为 false
deserializationOptions.doNotRecalculateAfterLoad:可选,加载后是否避免重新计算,默认为 false
window.onload = function() {
var spread = new GC.Spread.Sheets.Workbook(_getElementById('ss'), { sheetCount: 3 });
var spread2 = new GC.Spread.Sheets.Workbook(_getElementById('ss1'), { sheetCount: 1 });
initSpread(spread);
};
function initSpread(spread) {
var sheet = spread.getSheet(0);
fillStyle(sheet);
var pivotSourceSheet = spread.getSheet(1);
pivotSourceSheet.name("PivotSourceData");
var pivotSourceTableName = fillPivotSourceData(pivotSourceSheet);
var pivotTableSheet = spread.getSheet(2);
pivotTableSheet.name("PivotTable");
fillPivotTable(pivotTableSheet, pivotSourceTableName);
_getElementById('fromtoJsonBtn').addEventListener('click', function() {
var jsonOptions = {
ignoreFormula: !!_getElementById('import_noFormula').checked,
ignoreStyle: !!_getElementById('import_noStyle').checked,
frozenColumnsAsRowHeaders: !!_getElementById('import_rowHeaders').checked,
frozenRowsAsColumnHeaders: !!_getElementById('import_columnHeaders').checked,
doNotRecalculateAfterLoad: !!_getElementById('import_donotrecalculateafterload').checked
};
var serializationOption = {
ignoreFormula: !!_getElementById('noFormula').checked,
ignoreStyle: !!_getElementById('noStyle').checked,
rowHeadersAsFrozenColumns: !!_getElementById('SaveCustomRowHeaders').checked,
columnHeadersAsFrozenRows: !!_getElementById('SaveCustomColumnHeaders').checked
};
//ToJson
var spread1 = GC.Spread.Sheets.findControl(document.getElementById('ss'));
var jsonStr = JSON.stringify(spread1.toJSON(serializationOption));
//FromJson
var spread2 = GC.Spread.Sheets.findControl(document.getElementById('ss1'));;
spread2.fromJSON(JSON.parse(jsonStr), jsonOptions);
});
}
function fillStyle(sheet) {
var spreadNS = GC.Spread.Sheets;
sheet.suspendPaint();
sheet.frozenRowCount(4);
sheet.frozenColumnCount(4);
sheet.addSpan(1, 1, 1, 3);
sheet.setValue(1, 1, 'Store');
sheet.addSpan(1, 4, 1, 7);
sheet.setValue(1, 4, 'Goods');
sheet.addSpan(2, 1, 1, 2);
sheet.setValue(2, 1, 'Area');
sheet.addSpan(2, 3, 2, 1);
sheet.setValue(2, 3, 'ID');
sheet.addSpan(2, 4, 1, 2);
sheet.setValue(2, 4, 'Fruits');
sheet.addSpan(2, 6, 1, 2);
sheet.setValue(2, 6, 'Vegetables');
sheet.addSpan(2, 8, 1, 2);
sheet.setValue(2, 8, 'Foods');
sheet.addSpan(2, 10, 2, 1);
sheet.setValue(2, 10, 'Total');
sheet.setValue(3, 1, 'State');
sheet.setValue(3, 2, 'City');
sheet.setValue(3, 4, 'Grape');
sheet.setValue(3, 5, 'Apple');
sheet.setValue(3, 6, 'Potato');
sheet.setValue(3, 7, 'Tomato');
sheet.setValue(3, 8, 'SandWich');
sheet.setValue(3, 9, 'Hamburger');
sheet.addSpan(4, 1, 7, 1);
sheet.addSpan(4, 2, 3, 1);
sheet.addSpan(7, 2, 3, 1);
sheet.addSpan(10, 2, 1, 2);
sheet.setValue(10, 2, 'Sub Total:');
sheet.addSpan(11, 1, 7, 1);
sheet.addSpan(11, 2, 3, 1);
sheet.addSpan(14, 2, 3, 1);
sheet.addSpan(17, 2, 1, 2);
sheet.setValue(17, 2, 'Sub Total:');
sheet.addSpan(18, 1, 1, 3);
sheet.setValue(18, 1, 'Total:');
sheet.setValue(4, 1, 'NC');
sheet.setValue(4, 2, 'Raleigh');
sheet.setValue(7, 2, 'Charlotte');
sheet.setValue(4, 3, '001');
sheet.setValue(5, 3, '002');
sheet.setValue(6, 3, '003');
sheet.setValue(7, 3, '004');
sheet.setValue(8, 3, '005');
sheet.setValue(9, 3, '006');
sheet.setValue(11, 1, 'PA');
sheet.setValue(11, 2, 'Philadelphia');
sheet.setValue(14, 2, 'Pittsburgh');
sheet.setValue(11, 3, '007');
sheet.setValue(12, 3, '008');
sheet.setValue(13, 3, '009');
sheet.setValue(14, 3, '010');
sheet.setValue(15, 3, '011');
sheet.setValue(16, 3, '012');
sheet.setFormula(10, 4, '=SUM(E5:E10)');
sheet.setFormula(10, 5, '=SUM(F5:F10)');
sheet.setFormula(10, 6, '=SUM(G5:G10)');
sheet.setFormula(10, 7, '=SUM(H5:H10)');
sheet.setFormula(10, 8, '=SUM(I5:I10)');
sheet.setFormula(10, 9, '=SUM(J5:J10)');
sheet.setFormula(17, 4, '=SUM(E12:E17)');
sheet.setFormula(17, 5, '=SUM(F12:F17)');
sheet.setFormula(17, 6, '=SUM(G12:G17)');
sheet.setFormula(17, 7, '=SUM(H12:H17)');
sheet.setFormula(17, 8, '=SUM(I12:I17)');
sheet.setFormula(17, 9, '=SUM(J12:J17)');
for (var i = 0; i < 14; i++) {
sheet.setFormula(4 + i, 10, '=SUM(E' + (5 + i).toString() + ':J' + (5 + i).toString() + ')');
}
sheet.setFormula(18, 4, '=E11+E18');
sheet.setFormula(18, 5, '=F11+F18');
sheet.setFormula(18, 6, '=G11+G18');
sheet.setFormula(18, 7, '=H11+H18');
sheet.setFormula(18, 8, '=I11+I18');
sheet.setFormula(18, 9, '=J11+J18');
sheet.setFormula(18, 10, '=K11+K18');
sheet.getRange(1, 1, 3, 10).backColor('#F2F2F2');
sheet.getRange(4, 1, 15, 3).backColor('#CFCFCF');
sheet.getRange(1, 1, 3, 10).hAlign(spreadNS.HorizontalAlign.center);
sheet.getRange(1, 1, 18, 10).setBorder(new spreadNS.LineBorder('Black', spreadNS.LineStyle.thin), { all: true });
sheet.getRange(4, 4, 3, 6).setBorder(new spreadNS.LineBorder('Black', spreadNS.LineStyle.dotted), { inside: true });
sheet.getRange(7, 4, 3, 6).setBorder(new spreadNS.LineBorder('Black', spreadNS.LineStyle.dotted), { inside: true });
sheet
.getRange(11, 4, 3, 6)
.setBorder(new spreadNS.LineBorder('Black', spreadNS.LineStyle.dotted), { inside: true });
sheet
.getRange(14, 4, 3, 6)
.setBorder(new spreadNS.LineBorder('Black', spreadNS.LineStyle.dotted), { inside: true });
fillSampleData(sheet, new spreadNS.Range(4, 4, 6, 6));
fillSampleData(sheet, new spreadNS.Range(11, 4, 6, 6));
sheet.resumePaint();
}
function fillSampleData(sheet, range) {
for (var i = 0; i < range.rowCount; i++) {
for (var j = 0; j < range.colCount; j++) {
sheet.setValue(range.row + i, range.col + j, Math.ceil(Math.random() * 300));
}
}
}
function fillPivotSourceData(sheet) {
sheet.setRowCount(117);
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, pivotSales);
return table.name();
}
function fillPivotTable (sheet, tableName) {
sheet.setRowCount(1000);
let pivotTableOptions = {bandRows:true,bandColumns:true};
let pivotTable = sheet.pivotTables.add("PivotTable", tableName, 1, 1, GC.Spread.Pivot.PivotTableLayoutType.outline, GC.Spread.Pivot.PivotTableThemes.medium1, pivotTableOptions);
pivotTable.suspendLayout();
pivotTable.add("salesperson", "Salesperson", GC.Spread.Pivot.PivotTableFieldType.rowField);
pivotTable.add("car", "Cars", GC.Spread.Pivot.PivotTableFieldType.rowField);
pivotTable.add("date", "Date", GC.Spread.Pivot.PivotTableFieldType.columnField);
let groupInfo = { originFieldName: "date", dateGroups: [{ by: GC.Pivot.DateGroupType.quarters }] };
pivotTable.group(groupInfo);
pivotTable.add("total", "Totals", GC.Spread.Pivot.PivotTableFieldType.valueField, GC.Pivot.SubtotalType.sum);
let style = new GC.Spread.Sheets.Style();
style.formatter = "$ #,##0";
pivotTable.setStyle({dataOnly: true}, style);
pivotTable.resumeLayout();
pivotTable.autoFitColumn();
}
function _getElementById(id){
return document.getElementById(id);
}
<!doctype html>
<html style="height:100%;font-size:14px;">
<head>
<meta name="spreadjs culture" content="zh-cn" />
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="stylesheet" type="text/css"
href="$DEMOROOT$/zh/purejs/node_modules/@grapecity-software/spread-sheets/styles/gc.spread.sheets.excel2013white.css">
<script src="$DEMOROOT$/zh/purejs/node_modules/@grapecity-software/spread-sheets/dist/gc.spread.sheets.all.min.js"
type="text/javascript"></script>
<script
src="$DEMOROOT$/zh/purejs/node_modules/@grapecity-software/spread-sheets-resources-zh/dist/gc.spread.sheets.resources.zh.min.js"
type="text/javascript"></script>
<script
src="$DEMOROOT$/zh/purejs/node_modules/@grapecity-software/spread-sheets-shapes/dist/gc.spread.sheets.shapes.min.js"
type="text/javascript"></script>
<script
src="$DEMOROOT$/zh/purejs/node_modules/@grapecity-software/spread-sheets-pivot-addon/dist/gc.spread.pivot.pivottables.min.js"
type="text/javascript"></script>
<script src="$DEMOROOT$/spread/source/js/license.js" type="text/javascript"></script>
<script src="$DEMOROOT$/spread/source/data/pivot-data.js" type="text/javascript"></script>
<script src="app.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="styles.css">
</head>
<body>
<div class="sample-tutorial">
<div class="sample-spreadsheets">
<label style="font:bold 10pt arial">ToJson:</label>
<div id="ss"></div>
<label style="font:bold 10pt arial">FromJson:</label>
<div id="ss1"></div>
</div>
<div class="options-container">
<div>
<label>将第一个 Spread 实例序列化为 JSON 对象,然后将该对象反序列化为第二个 Spread 实例。</label>
<div class="option-row">
<input type="button" value="JSON 序列化" id="fromtoJsonBtn" />
</div>
<div>
<div class="container">
<div class="row" style="margin-top: 10px">
<div class="col-xs-12">
<label>FromJSON 选项:</label>
<div style="margin-top: 10px">
<input type="checkbox" id="import_noFormula" />
<label style="text-align: left" for="import_noFormula">忽略公式</label>
<input type="checkbox" id="import_noStyle" />
<label style="text-align: left" for="import_noStyle">忽略样式</label>
</div>
<div style="margin-top: 10px">
<input type="checkbox" id="import_rowHeaders" />
<label style="text-align: left" for="import_rowHeaders">将冻结列视为行标题</label>
</div>
<div style="margin-top: 10px">
<input type="checkbox" id="import_columnHeaders" />
<label style="text-align: left" for="import_columnHeaders">将冻结行视为列标题</label>
</div>
<div style="margin-top: 10px">
<input type="checkbox" id="import_donotrecalculateafterload" />
<label style="text-align: left" for="import_donotrecalculateafterload">加载后避免重新计算</label>
</div>
</div>
</div>
<div class="row" style="margin-top: 20px">
<div class="col-xs-12">
<label>ToJSON 选项:</label>
<div style="margin-top: 10px">
<input type="checkbox" id="noFormula" />
<label style="text-align: left" for="noFormula">忽略公式</label>
<input type="checkbox" id="noStyle" />
<label style="text-align: left" for="noStyle">忽略样式</label>
</div>
<div style="margin-top: 10px">
<input type="checkbox" id="SaveCustomRowHeaders" />
<label style="text-align: left" for="SaveCustomRowHeaders">将行标题视为冻结列</label>
</div>
<div style="margin-top: 10px">
<input type="checkbox" id="SaveCustomColumnHeaders" />
<label style="text-align: left" for="SaveCustomColumnHeaders">将列标题视为冻结行</label>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
input[type="checkbox"] {
margin-left: 20px;
}
.colorLabel {
background-color: #F4F8EB;
}
.sample-tutorial {
display: flex;
height: 100%;
overflow: hidden;
}
.sample-spreadsheets {
flex: 1;
display: flex;
flex-direction: column;
height: 100%;
overflow: hidden;
}
.sample-spreadsheets > label {
flex-shrink: 0;
}
#ss, #ss1 {
flex: 1;
min-height: 0;
}
.options-container {
width: 302px;
flex-shrink: 0;
padding: 12px;
height: 100%;
box-sizing: border-box;
background: #fbfbfb;
overflow: auto;
}
.option-row {
font-size: 14px;
padding: 5px;
margin-top: 10px;
}
label {
margin-bottom: 6px;
}
input {
padding: 4px 6px;
}
input[type=button] {
margin-top: 6px;
display: block;
}
body {
position: absolute;
top: 0;
bottom: 0;
left: 0;
right: 0;
}