概述
本 Demo 展示了如何自定义工作表的行头和列头区域。Demo 演示了设置多个表头行列、合并表头单元格、配置自动文本类型以及控制表头可见性等功能。
实现思路
设置列头的行数和行头的列数,创建多行多列的表头区域
使用 addSpan 方法合并表头单元格,创建分层结构
为合并后的表头单元格设置自定义文本
配置列头的自动文本类型和显示位置
通过复选框控制行头和列头的显示与隐藏
通过下拉框动态切换表头的自动文本类型
代码解析
设置表头行列数
通过 setRowCount 和 setColumnCount 方法分别设置列头的行数和行头的列数。SheetArea.colHeader 表示列头区域,SheetArea.rowHeader 表示行头区域。
配置表头自动文本
colHeaderAutoTextIndex 指定列头中哪一行显示自动文本(索引从 0 开始)。HeaderAutoText 枚举提供三种类型:blank(空白)、letters(字母)、numbers(数字)。
合并行头单元格
addSpan 方法用于合并单元格,参数依次为:起始行、起始列、合并的行数、合并的列数、工作表区域。
控制表头显示
通过设置 rowHeaderVisible 和 colHeaderVisible 属性可以控制行头和列头的显示状态。
运行效果
工作表左侧显示多列行头,上方显示多行列头,形成分层结构
列头的第 3 行显示数字序号(1、2、3…),其他行显示自定义文本
勾选或取消勾选"显示列标题"复选框,可以显示或隐藏列头区域
勾选或取消勾选"显示行标题"复选框,可以显示或隐藏行头区域
选择自动文本类型(空白/字母/数字)并点击"设置"按钮,可以动态更改表头的显示方式
API 参考
setRowCount 方法
rowCount:行数
sheetArea:工作表区域,如 SheetArea.colHeader、SheetArea.rowHeader、SheetArea.viewport
guardContent:可选,保护内容的选项
setColumnCount 方法
colCount:列数
sheetArea:工作表区域
guardContent:可选,保护内容的选项
addSpan 方法
row:起始行索引
col:起始列索引
rowCount:合并的行数
colCount:合并的列数
sheetArea:工作表区域
HeaderAutoText 枚举
blank:空白,不显示自动文本
letters:字母,显示 A、B、C…
numbers:数字,显示 1、2、3…
表头相关选项
rowHeaderVisible:行头是否可见
colHeaderVisible:列头是否可见
rowHeaderAutoText:行头自动文本类型
colHeaderAutoText:列头自动文本类型
rowHeaderAutoTextIndex:行头中显示自动文本的列索引
colHeaderAutoTextIndex:列头中显示自动文本的行索引
window.onload = function () {
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
var spreadNS = GC.Spread.Sheets;
var sheet = spread.getSheet(0);
sheet.suspendPaint();
//Set rowHeader count and columnHeader count.
sheet.setRowCount(3, spreadNS.SheetArea.colHeader);
sheet.setColumnCount(3, spreadNS.SheetArea.rowHeader);
//Change header "auto text".
sheet.options.colHeaderAutoTextIndex = 2;
sheet.options.colHeaderAutoText = spreadNS.HeaderAutoText.numbers;
//Span three columns with the origin at column header cell (0,0).
sheet.addSpan(0, 0, 10, 1, GC.Spread.Sheets.SheetArea.rowHeader);
sheet.addSpan(0, 1, 5, 1, GC.Spread.Sheets.SheetArea.rowHeader);
sheet.addSpan(5, 1, 5, 1, GC.Spread.Sheets.SheetArea.rowHeader);
sheet.setValue(0, 1, "Sub 1.", GC.Spread.Sheets.SheetArea.rowHeader);
sheet.setValue(5, 1, "Sub 2.", GC.Spread.Sheets.SheetArea.rowHeader);
sheet.setValue(0, 0, "Cat.", GC.Spread.Sheets.SheetArea.rowHeader);
sheet.addSpan(0, 0, 2, 1, GC.Spread.Sheets.SheetArea.colHeader);
sheet.addSpan(0, 1, 1, 2, GC.Spread.Sheets.SheetArea.colHeader);
sheet.addSpan(0, 3, 2, 1, GC.Spread.Sheets.SheetArea.colHeader);
sheet.addSpan(0, 4, 2, 1, GC.Spread.Sheets.SheetArea.colHeader);
sheet.addSpan(0, 5, 2, 1, GC.Spread.Sheets.SheetArea.colHeader);
sheet.addSpan(0, 6, 2, 1, GC.Spread.Sheets.SheetArea.colHeader);
sheet.setValue(0, 0, "No.", GC.Spread.Sheets.SheetArea.colHeader);
sheet.setValue(0, 1, "Company", GC.Spread.Sheets.SheetArea.colHeader);
sheet.setValue(0, 3, "Order ID", GC.Spread.Sheets.SheetArea.colHeader);
sheet.setValue(0, 4, "Customer ID", GC.Spread.Sheets.SheetArea.colHeader);
sheet.setValue(0, 5, "Employee ID", GC.Spread.Sheets.SheetArea.colHeader);
sheet.setValue(0, 6, "Order Date", GC.Spread.Sheets.SheetArea.colHeader);
sheet.setValue(1, 1, "Country", GC.Spread.Sheets.SheetArea.colHeader);
sheet.setValue(1, 2, "Company Name", GC.Spread.Sheets.SheetArea.colHeader);
sheet.getCell(-1, 0).width(40);
sheet.getRange(-1, 1, 1, 6).width(130);
sheet.getRange(-2, 1, 1, 2).width(130);
sheet.resumePaint();
/*
* Show or hide the row header.
*/
_getElementById("chkRowHeaderVisible").addEventListener('click',function () {
var sheet = spread.getActiveSheet();
sheet.options.rowHeaderVisible = this.checked;
spread.invalidateLayout();
spread.repaint();
});
/*
* Show or hide the column header.
*/
_getElementById("chkColumnHeaderVisible").addEventListener('click',function () {
var sheet = spread.getActiveSheet();
sheet.options.colHeaderVisible = this.checked;
spread.invalidateLayout();
spread.repaint();
});
_getElementById("btnSetAutoText").addEventListener('click',function () {
var headerType = document.querySelector("input[name='headerType']:checked").value,
obj=_getElementById("headerAutoTextType"),
headerAutoTextType = obj.options[obj.selectedIndex].value;
if (headerAutoTextType) {
headerAutoTextType = spreadNS.HeaderAutoText[headerAutoTextType];
if (!(headerAutoTextType === undefined)) {
switch (headerType) {
case "row":
sheet.options.rowHeaderAutoText = headerAutoTextType;
break;
case "column":
sheet.options.colHeaderAutoText = headerAutoTextType;
break;
}
}
}
});
};
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">
<label>设置以下选项以显示列/行标题。</label>
<div class="option-row">
<input type="checkbox" id="chkColumnHeaderVisible" checked />
<label for="chkColumnHeaderVisible">显示列标题</label>
</div>
<div class="option-row">
<input type="checkbox" id="chkRowHeaderVisible" checked />
<label for="chkRowHeaderVisible">显示行标题</label>
</div>
<hr>
<div class="option-row">
<label>使用以下选项设置标题的自动文本类型。</label>
</div>
<div class="option-row">
<input type="radio" name="headerType" value="row" id="headerTypeRow" /><label
for="headerTypeRow">行</label>
<input type="radio" name="headerType" value="column" id="headerTypeColumn" checked="checked" /><label
for="headerTypeColumn">列</label>
</div>
<div class="option-row">
<label for="headerAutoTextType" style="display:inline-block;">标题自动文本类型: </label>
</div>
<select id="headerAutoTextType" style="padding-left: 5px">
<option value="blank">空白</option>
<option value="letters" selected="selected">字母</option>
<option value="numbers">数字</option>
</select>
<input type="button" id="btnSetAutoText" value="设置" />
</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 {
margin-bottom: 6px;
}
input {
padding: 4px 6px;
}
input[type=button] {
margin-top: 6px;
}
body {
position: absolute;
top: 0;
bottom: 0;
left: 0;
right: 0;
}