概述
本 Demo 展示了 SpreadJS 表格在扩展时自动应用数据验证规则和条件格式的特性。Demo 中创建了一个包含数据验证和条件格式的表格,当用户在表格最后一行按 Tab 键添加新行时,原有的数据验证规则(限制输入数值不在 4-6 之间)和条件格式规则(数值大于 8 时高亮显示)会自动应用到新添加的行。
实现思路
使用 tables.add 方法创建一个 9 行 5 列的表格,应用 medium4 主题样式
为表格填充数据,第 3-10 行的 5 列数据依次递增
创建条件格式样式,使用 addCellValueRule 方法为第 5 列(F 列)设置规则:数值大于 8 时显示浅绿色背景和绿色前景色
使用 createNumberValidator 创建数字验证器,规则为数值不在 4-6 之间
通过 getRange().validator() 为表格的所有数据列(第 1-5 列)应用数据验证
启用无效数据高亮显示(spread.options.highlightInvalidData = true)
代码解析
创建表格并填充数据
这段代码创建了一个名为 "Table1" 的表格,起始位置在第 2 行第 1 列,包含 9 行 5 列,使用 medium4 主题样式。然后通过循环为表格填充递增的数据。
设置条件格式规则
这段代码创建了一个条件格式规则:当单元格数值大于 8 时,应用浅绿色背景和绿色前景色。addCellValueRule 方法的参数依次为:比较运算符(greaterThan 表示大于)、比较值 1(8)、比较值 2(0,此处未使用)、样式对象、应用范围的数组。
设置数据验证规则
这段代码首先启用了无效数据高亮显示功能。然后为表格的所有数据列(第 3-10 行,第 1-5 列)设置数据验证规则:数值不能在 4-6 之间。createNumberValidator 方法的参数依次为:比较运算符(notBetween 表示不在范围内)、最小值(4)、最大值(6)、是否为整数值(false 表示可以是小数)。
运行效果
表格初始显示 9 行数据,第 B-F 列都应用了数据验证规则,第 F 列还应用了条件格式规则
点击表格最后一行(第 11 行)的任意单元格,按 Tab 键会在表格末尾添加一个新行
在新行的第 B 列(例如 B12)输入 "5",由于该值在 4-6 之间,违反数据验证规则,单元格会被高亮显示为无效数据
在新行的第 F 列(F12)输入 "10",由于该值大于 8,满足条件格式规则,单元格会显示浅绿色背景和绿色前景色
所有验证规则和格式规则都自动应用到新行,无需额外代码
API 参考
tables.add 方法
name:表格名称
row:起始行索引
column:起始列索引
rowCount:表格行数
columnCount:表格列数
style:表格主题样式
conditionalFormats.addCellValueRule 方法
comparisonOperator:比较运算符,使用 GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators 枚举
value1:第一个比较值
value2:第二个比较值(部分运算符需要)
style:满足条件时应用的样式
ranges:应用范围的数组,使用 GC.Spread.Sheets.Range 对象
DataValidation.createNumberValidator 方法
typeOperator:比较运算符
v1:第一个比较值
v2:第二个比较值
isIntegerValue:是否限制为整数
Range.validator 方法
row、col:起始行列索引
rowCount、colCount:行数和列数
dataValidator:数据验证器对象
window.onload = function () {
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
initSpread(spread);
};
function initSpread(spread) {
var sheet1 = spread.getSheet(0);
var spreadNS = GC.Spread.Sheets;
var table = sheet1.tables.add("Table1", 2, 1, 9, 5, spreadNS.Tables.TableThemes["medium4"]);
for (var i = 1; i <= 8; i++) {
sheet1.getCell(2 + i, 1).value(i + 1);
sheet1.getCell(2 + i, 2).value(i + 2);
sheet1.getCell(2 + i, 3).value(i + 3);
sheet1.getCell(2 + i, 4).value(i + 4);
sheet1.getCell(2 + i, 5).value(i + 5);
}
sheet1.setColumnWidth(1, 100);
sheet1.setColumnWidth(2, 100);
sheet1.setColumnWidth(3, 100);
sheet1.setColumnWidth(4, 100);
sheet1.setColumnWidth(5, 100);
var cfs = sheet1.conditionalFormats;
var style = new spreadNS.Style();
style.backColor = '#F4F8EB';
style.foreColor = '#82bc00';
//apply style for numbers greater than 8
var cvRule = cfs.addCellValueRule(
spreadNS.ConditionalFormatting.ComparisonOperators.greaterThan,
8, 0, style, [new GC.Spread.Sheets.Range(3, 5, 8, 1)]);
spread.options.highlightInvalidData = true;
//Numbers between 4,6 are invalid
sheet1.getRange(3, 1, 8, 5).validator(spreadNS.DataValidation.createNumberValidator(spreadNS.ConditionalFormatting.ComparisonOperators.notBetween, 4, 6, false));
}
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">
<label>Table's columns B:F have data validation rules. Column F also has conditional formatting rules.
</label>
<label>Click in cell F11 (value ‘13’) and press the Tab key. A new row will be added. </label>
<label><b>You can follow the rules in the above rows to see this in action. </b></label>
<label>For example, in B12, type ‘5’. This is not a valid value so it will be highlighted. </label>
<label>Type ‘10’ in F12 to highlight is using the conditional formatting rules.</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;
}
label {
display: block;
margin-bottom: 6px;
}
body {
position: absolute;
top: 0;
bottom: 0;
left: 0;
right: 0;
}