概述
本 Demo 展示了如何使用 suspendPaint 和 resumePaint 方法控制表单的绘制机制。通过三个按钮交互,演示了暂停渲染、批量设置数据和恢复渲染的完整流程,帮助理解如何优化大量数据操作时的性能。
实现思路
初始化 SpreadJS 工作簿,创建一个工作表
为三个按钮绑定点击事件:暂停渲染、设置值数组、恢复渲染
点击"暂停渲染"按钮时,调用 spread.suspendPaint() 暂停整个工作簿的绘制机制
点击"设置值数组"按钮时,获取当前选中的单元格区域,使用 setArray 方法批量设置销售数据,并为每个单元格设置前景色
点击"恢复渲染"按钮时,调用 spread.resumePaint() 恢复绘制机制,此时所有未渲染的修改会一次性完成渲染
代码解析
暂停和恢复绘制
这段代码为两个按钮绑定了事件处理函数。suspendPaint() 方法暂停工作簿的绘制机制,此后所有的修改都不会立即渲染到界面上;resumePaint() 方法恢复绘制机制,触发一次完整的渲染。
批量设置单元格数据
这段代码首先获取当前选中的单元格区域,然后使用 setArray 方法批量设置销售数据到选中的起始位置。接着通过循环为每个单元格设置前景色。如果在暂停渲染状态下执行这些操作,所有修改都不会立即渲染,直到调用 resumePaint() 方法。
运行效果
初始状态工作表为空白
直接点击"设置值数组"按钮,在选中的单元格区域设置数据,每次操作都会立即触发重绘
如果先点击"暂停渲染"按钮,再点击"设置值数组"按钮,最后点击"恢复渲染"按钮,所有的数据设置和样式修改会在最后一次完成渲染,提升操作性能
通过对比两种方式的性能差异,可以理解暂停绘制机制在批量操作中的优化作用
API 参考
suspendPaint 方法
暂停绘制机制,可以在工作簿级别或工作表级别调用。暂停期间,所有的修改都不会立即渲染。
resumePaint 方法
恢复绘制机制,触发一次完整的渲染,显示所有暂停期间积累的修改。
setArray 方法
row:起始行索引
column:起始列索引
array:二维数组,包含要设置的值
setFormula:可选,是否设置为公式(默认为 false)
window.onload = function() {
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), {
sheetCount: 1
});
var spreadNS = GC.Spread.Sheets;
document.getElementById("setValue").addEventListener('click',function() {
var sheet = spread.getActiveSheet();
var cellRange = sheet.getSelections()[0];
var salesData = [
["Salesperson", "Region", "Sales Amount", "Commission %", "Commission Amount"],
["Joe", "North", 260, '10%', 26],
["Robert", "South", 660, '15%', 99],
["Michelle", "East", 940, '15%', 141],
["Erich", "West", 410, '12%', 49.2],
["Dafna", "North", 800, '15%', 120],
["Rob", "South", 900, '15%', 135]
];
if (cellRange) {
for (var row = cellRange.row, rowCount = cellRange.row + cellRange.rowCount; row < rowCount; row++) {
for (var col = cellRange.col, colCount = cellRange.col + cellRange.colCount; col < colCount; col++) {
sheet.setArray(row, col, salesData);
sheet.getCell(row, col).foreColor("lightGreen");
sheet.getCell(row, ++col).foreColor("lightGreen");
sheet.getCell(row, ++col).foreColor("lightGreen");
sheet.getCell(row, ++col).foreColor("lightGreen");
sheet.getCell(row, ++col).foreColor("lightGreen");
}
}
}
});
document.getElementById("suspendPaint").addEventListener('click',function() {
spread.suspendPaint();
});
document.getElementById("resumePaint").addEventListener('click',function() {
spread.resumePaint();
});
};
<!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$/spread/source/js/license.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 id="ss" class="sample-spreadsheets"></div>
<div class="options-container">
<div class="option-row">
<input type="button" id="suspendPaint" value="暂停渲染" />
<label>1. 暂停工作簿的渲染</label>
</div>
<div class="option-row">
<input type="button" id="setValue" value="设置值数组" />
<label>2. 在工作表上设置一组范围的值</label>
</div>
<div class="option-row">
<input type="button" id="resumePaint" value="恢复渲染" />
<label>3. 恢复工作簿的渲染</label>
</div>
</div>
</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;
}
.option-row {
font-size: 14px;
padding: 5px;
margin-top: 10px;
}
label {
display: block;
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;
}