概述
本 Demo 展示了如何通过代码和用户交互两种方式控制工作表的选择状态。Demo 初始化了 5 个工作表,默认选中前 3 个,并通过复选框和工作表标签实现了双向同步:用户既可以通过复选框切换工作表选中状态,也可以通过 Shift/Ctrl/Cmd 键点击工作表标签进行多选,两种方式的操作结果会实时同步。
实现思路
初始化包含 5 个工作表的工作簿,并设置前 3 个工作表为选中状态
为每个工作表对应的复选框添加 change 事件监听器,当复选框状态改变时调用 isSelected() 方法更新工作表选中状态
监听 SpreadJS 的 SheetChanged 事件,当工作表选择状态改变时自动更新对应复选框的选中状态
支持 SpreadJS 内置的多选功能(Shift/Ctrl/Cmd + 点击工作表标签)
代码解析
初始化工作表选中状态
这段代码首先通过 getSheetFromName() 方法获取前三个工作表对象,然后调用 isSelected(true) 将它们设置为选中状态。接着监听 SheetChanged 事件,当任何工作表的属性(包括选中状态)发生变化时,根据事件参数中的 sheetName 找到对应的复选框元素,并切换其选中状态。
复选框事件处理
这段代码为每个工作表对应的复选框添加了 change 事件监听器。当用户点击复选框时,首先通过工作表名称获取对应的工作表对象,然后调用 isSelected(this.checked) 方法设置工作表的选中状态,最后调用 repaint() 重绘界面以更新工作表标签的显示。
运行效果
页面加载后,前 3 个工作表(Sheet1、Sheet2、Sheet3)默认处于选中状态,对应复选框显示为选中
点击右侧的复选框可以切换对应工作表的选中状态,工作表标签会实时更新视觉反馈
按住 Shift/Ctrl(Windows)或 Shift/Cmd(macOS)键点击工作表标签,可以多选或取消选择工作表,复选框状态会自动同步
活动工作表始终处于选中状态,无法通过复选框取消选中
API 参考
isSelected 方法
selectedState:可选,布尔值,设置工作表的选中状态
无参数时返回当前工作表的选中状态(布尔值)
有参数时返回工作表对象本身,支持链式调用
getSheetFromName 方法
name:字符串,工作表名称
返回值:对应的工作表对象
SheetChanged 事件
此事件在工作表属性发生变化后触发,包括选中状态(isSelected)、可见性(isVisible)等属性的变化。
window.onload = function () {
var spread = new GC.Spread.Sheets.Workbook(_getElementById('ss'), { sheetCount: 5 });
initCheckBoxesEvent(spread);
initSpread(spread);
};
function initCheckBoxesEvent(spread) {
var sheetsNames = ["Sheet1", "Sheet2", "Sheet3", "Sheet4", "Sheet5"];
sheetsNames.forEach(function (name) {
document.getElementById(name).addEventListener('change', function (e) {
var sheet = spread.getSheetFromName(name);
if (sheet) {
sheet.isSelected(this.checked);
spread.repaint();
}
});
});
}
function initSpread(spread) {
var sheet1 = spread.getSheetFromName("Sheet1");
var sheet2 = spread.getSheetFromName("Sheet2");
var sheet3 = spread.getSheetFromName("Sheet3");
sheet1.isSelected(true);
sheet2.isSelected(true);
sheet3.isSelected(true);
spread.bind(GC.Spread.Sheets.Events.SheetChanged, function (e, args) {
var checkboxElement = document.getElementById(args.sheetName);
if (checkboxElement) {
checkboxElement.checked = !checkboxElement.checked;
}
});
spread.repaint();
}
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$/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">
<p>点击复选框以选择或取消选择工作表。</p>
<p>按住 Shift/Ctrl/Cmd 键并点击工作表标签以选择/取消选择多个工作表。工作表复选框将相应更新。</p>
</div>
<div class="sheets-checkboxes-container">
<div class="option-row">
<input type="checkbox" id="Sheet1" checked />
<label for="Sheet1" id="labelOfSheet1">Sheet1</label>
</div>
<div class="option-row">
<input type="checkbox" id="Sheet2" checked />
<label for="Sheet2" id="labelOfSheet2">Sheet2</label>
</div>
<div class="option-row">
<input type="checkbox" id="Sheet3" checked />
<label for="Sheet3" id="labelOfSheet3">Sheet3</label>
</div>
<div class="option-row">
<input type="checkbox" id="Sheet4" />
<label for="Sheet4" id="labelOfSheet4">Sheet4</label>
</div>
<div class="option-row">
<input type="checkbox" id="Sheet5" />
<label for="Sheet5" id="labelOfSheet5">Sheet5</label>
</div>
</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;
}
.sheets-checkboxes-container {
padding-left: 10px;
}
label {
margin-bottom: 6px;
}
input {
padding: 4px 6px;
}
hr {
border-color: #fff;
opacity: .2;
margin-top: 20px;
}
body {
position: absolute;
top: 0;
bottom: 0;
left: 0;
right: 0;
}