概述
本 Demo 展示了如何通过代码控制工作表的可见性状态,包括隐藏工作表、显示隐藏的工作表、深度隐藏工作表以及显示深度隐藏的工作表四种操作。
实现思路
初始化 Spread 工作簿
提供“隐藏工作表”按钮,将当前活动工作表设置为隐藏状态
提供“显示工作表”按钮,将隐藏状态的工作表恢复为可见
提供“深度隐藏工作表”按钮,将当前活动工作表设置为深度隐藏状态
提供“显示深度隐藏的工作表”按钮,将深度隐藏的工作表恢复为可见
在隐藏或深度隐藏前,先切换活动工作表,避免隐藏当前活动工作表
代码解析
隐藏当前活动工作表
这段代码首先获取当前活动工作表及其索引,然后将前一个工作表设置为活动工作表,最后将原活动工作表设置为隐藏。visible(false) 方法将工作表设置为隐藏状态。
显示隐藏的工作表
这段代码遍历所有工作表,找到第一个隐藏状态的工作表(visible() === 0),然后将其设置为可见。visible(true) 方法将工作表设置为可见状态。
深度隐藏工作表
这段代码将当前活动工作表设置为深度隐藏状态。visible(2) 使用数字参数设置工作表为深度隐藏,用户无法通过 UI 取消隐藏。
显示深度隐藏的工作表
这段代码查找第一个深度隐藏的工作表(visible() === 2),然后将其恢复为可见状态。深度隐藏的工作表只能通过代码设置为可见。
运行效果
点击“隐藏工作表”按钮,当前活动工作表会被隐藏,活动状态切换到前一个工作表
点击“显示工作表”按钮,第一个隐藏的工作表会恢复显示
点击“深度隐藏工作表”按钮,当前活动工作表会被深度隐藏,用户无法通过右键菜单取消隐藏
点击“显示深度隐藏的工作表”按钮,第一个深度隐藏的工作表会恢复显示
API 参考
visible 方法
value:可选参数,接受布尔值或 SheetTabVisible 枚举
true 或 SheetTabVisible.visible:工作表可见
false 或 SheetTabVisible.hidden(等同于 0):工作表隐藏
SheetTabVisible.veryHidden(等同于 2):工作表深度隐藏
返回值:不传参数时返回当前可见状态(0 表示隐藏,1 表示可见,2 表示深度隐藏)
SheetTabVisible 枚举
visible:工作表可见
hidden:工作表隐藏,用户可通过右键菜单取消隐藏
veryHidden:工作表深度隐藏,用户无法通过 UI 取消隐藏,只能通过代码设置可见
注意:深度隐藏的工作表有以下限制:
无法设置为活动工作表
无法选择工作表
无法使用查找或替换检索工作表的内容
无法打印工作表
window.onload = function() {
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
initSpread(spread);
document.getElementById("btnVisible").addEventListener('click',function() {
for (var i = 0; i < spread.sheets.length; i++) {
if (spread.sheets[i].visible() === 0) {
spread.sheets[i].visible(true);
break;
}
}
});
document.getElementById("btnInvisible").addEventListener('click',function() {
var sheet = spread.getActiveSheet();
if (sheet) {
var activeIndex = spread.getActiveSheetIndex();
if (activeIndex - 1 >= 0) {
spread.setActiveSheetIndex(activeIndex - 1);
}
sheet.visible(false);
}
});
document.getElementById("btnShowVeryHidden").addEventListener('click',function() {
for (var i = 0; i < spread.sheets.length; i++) {
if (spread.sheets[i].visible() === 2) {
spread.sheets[i].visible(true);
break;
}
}
});
document.getElementById("btnVeryHidden").addEventListener('click',function() {
var sheet = spread.getActiveSheet();
if (sheet) {
var activeIndex = spread.getActiveSheetIndex();
if (activeIndex - 1 >= 0) {
spread.setActiveSheetIndex(activeIndex - 1);
}
sheet.visible(2);
}
});
};
function initSpread(spread) {
var sheet = spread.getActiveSheet();
}
<!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$/spread/source/data/data.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="btnInvisible" value="隐藏工作表" />
</div>
<div class="option-row">
<input type="button" id="btnVisible" value="显示工作表" />
</div>
<div class="option-row">
<input type="button" id="btnVeryHidden" value="深度隐藏工作表" />
</div>
<div class="option-row">
<input type="button" id="btnShowVeryHidden" value="显示深度隐藏的工作表" />
</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;
}