提示:本文档的示例代码仅适用于本文档中的示例报表/场景。若实际报表/场景与示例代码无法完全适配(如使用功能不一致,或多个宏代码冲突等),需根据实际需求开发代码。
示例说明
客户需求:在电子表格报表中,有时候因需要隐藏的sheet页名称不定,每次都重新在Excel上编辑比较麻烦,希望可以浏览器可以直接设置隐藏的sheet名称。类似上述需求,可以参照如下方法进行设置。参考示例:
(注:此示例不适用于隐藏直接在Excel上发布时的sheet页的名称,如果需要隐藏直接发布的sheet页,请在excel上进行重新发布其他的sheet页到smartbi中)
隐藏前:
通过宏隐藏后:
版本及客户端说明
1.smartbi版本:v6.2/v7.0
2.客户端:PC
3.浏览器:IE11、谷歌浏览器(Chrome)、火狐浏览器(Firefox)
设置方法
1、首先在电子表格设计器(Microsoft Office Excel)中,创建多sheet的电子表格报表。
2、在浏览器的资源定制节点下,选中电子表格,右键选择 编辑宏 进入报表宏界面。
3、在报表宏界面新建客户端模块。在弹出的新建模块对话框中,选择对象为spreadSheetReport、事件为onRenderReport、并把下面宏代码复制到代码编辑区域。
宏类型
类型 | 对象 | 事件 |
---|---|---|
ClientSide | spreadsheetReport | onRenderReport |
宏代码
function main(spreadsheetReport) { debugger; var hideSheets = ['Sheet4', 'Sheet5']; //数组里边写需要隐藏的sheet页名称 for (var k = 0; k < hideSheets.length; k++) { var removeSheetName = hideSheets[k]; for (var i = 0; i < spreadsheetReport.visibleSheetNames.length; i++) { if (spreadsheetReport.visibleSheetNames[i] == removeSheetName) { var row = spreadsheetReport.sheetsTable.rows[0]; for (var j = 0; j < row.cells.length; j++) { if (row.cells[j]._sheetName == removeSheetName) { row.removeChild(row.cells[j]); break; } } spreadsheetReport.visibleSheetNames.splice(i, 1); break; } } } if (spreadsheetReport.moreTdSheets) { var div = spreadsheetReport.moreTdSheets.firstChild; while (div) { if (div._sheetName == removeSheetName) { spreadsheetReport.moreTdSheets.removeChild(div); break; } div = div.nextSibling; } } spreadsheetReport.doOnWindowResize({ target: window }); }
相关资源:migrate.xml
注:此宏代码只是前端隐藏了sheet页,实际数据与导出不影响。
实现思路:
从spreadsheetReport.visibleSheetNames中找到并通过splice(idx, 1)这样从中删除。再调用spreadsheetReport.doOnWindowResize({target:window});
idx是指Sheet的索引号(可见的索引,非全局的索引),从0开始数。
评论
刘怡霞 发表:
需求:如果需要在导出或打印时,隐藏的sheet页也不显示,在添加以上客户端宏的基础上,添加以下服务端宏代码即可。
function main(spreadsheetReport) {
var workbook=spreadsheetReport.workbook;
//Sheet4 Sheet5 要隐藏的sheet页名称,多个sheet页修改sheet名称重复下面两行代码
var sheet4 = workbook.getWorksheets().get("Sheet4");
sheet4.setVisible(false);//导出隐藏sheet页
//导出删除sheet页
//var sheet4 = workbook.getWorksheets();
//sheet4.removeAt("sheet4");
var sheet5 = workbook.getWorksheets().get("Sheet5");
sheet5.setVisible(false);
}