概述
本 Demo 展示了如何在集算表视图中自定义列单元格的样式和显示格式。通过公式格式化器、条件格式和单元格按钮等功能,实现了地址列的组合显示、运费的条件高亮、客户列的下拉选择以及员工信息的格式化展示。
实现思路
使用数据管理器添加订单表、客户表和员工表,并建立表间关系
创建集算表并定义自定义视图
为不同列设置不同的样式:
地址列使用公式格式化器组合显示地址和城市
运费列添加条件格式,大于 50 时背景变粉色
日期列添加日期选择器按钮
客户列设置下拉选择样式
员工列组合显示姓名和地区
阻止 Customer 列的直接编辑,仅允许通过下拉选择
代码解析
使用公式格式化器组合显示地址信息
这段代码定义了地址列的样式。formatter 属性使用模板公式语法 {{=...}},通过 CONCAT 函数将发货地址和城市组合显示。@ 符号代表当前行的完整数据,可以访问行中的所有字段。
设置条件格式
条件格式使用 formulaRule 类型,formula 属性指定条件公式 @>50,当单元格值大于 50 时,应用指定的样式(背景色为粉色)。
添加日期选择器按钮
在 style 中配置 cellButtons 属性,添加日期选择器按钮。command 指定打开日期选择器的命令,imageType 设置按钮图标类型,useButtonStyle 使按钮使用按钮样式显示。
关联表数据的格式化显示
通过 [@customer.字段名] 语法访问关联表的数据。这里将客户表的公司名称和联系人姓名组合显示。
创建自定义视图
addView 方法创建自定义视图,每个列配置包含 value(字段名或公式)、caption(标题)、width(宽度)等属性。value: "=[@]" 表示该列包含整行数据,可在格式化器中访问任意字段。
阻止特定列编辑
通过监听 EditStarting 事件,检查列标题是否为 'Customer',如果是则取消编辑操作,强制用户通过下拉选择器选择客户。
运行效果
表格加载后显示订单数据,地址列显示为 "Ship To: 地址, 城市" 格式
运费列中大于 50 的单元格背景显示为粉色
点击日期列的下拉按钮,会弹出日期选择器
点击客户列的下拉按钮,会显示客户列表供选择
员工列显示为 "姓 名 (地区)" 格式
无法直接编辑 Customer 列,只能通过下拉选择器选择
API 参考
addView 方法
name:视图名称
columns:列配置数组,每列可设置 value、caption、width、style、conditionalFormats 等属性
formulaRule 条件格式
ruleType:规则类型,固定为 "formulaRule"
formula:条件公式,使用 @ 引用当前单元格值
style:满足条件时应用的样式
/*REPLACE_MARKER*/
/*DO NOT DELETE THESE COMMENTS*/
window.onload = function() {
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), { sheetCount: 0 });
initSpread(spread);
};
function initSpread(spread) {
spread.suspendPaint();
spread.options.autoFitType = GC.Spread.Sheets.AutoFitType.cellWithHeader;
spread.bind(GC.Spread.Sheets.Events.EditStarting, function (e, args) {
if (args.sheet.getValue(0, args.col, GC.Spread.Sheets.SheetArea.colHeader) === 'Customer'){
args.cancel = true;
}
});
//init a data manager
var baseApiUrl = getBaseApiUrl();
var dataManager = spread.dataManager();
//add order table
var orderTable = dataManager.addTable("orderTable", {
remote: {
read: {
url: baseApiUrl + "/Order"
}
},
schema: {
columns: {
CustomerId: {
lookup: {
name: 'customer', columns: [
{ value: "Id", width: 60 },
{ value: "CompanyName", width: 200 },
{ value: "ContactName", width: 140 },
{ value: "ContactTitle", width: 140 }
]
}
}
}
}
});
//add customer table
var customerTable = dataManager.addTable("customerTable", {
remote: {
read: {
url: baseApiUrl + "/Customer"
}
}
});
var employeeTable = dataManager.addTable("employeeTable", {
remote: {
read: {
url: baseApiUrl + "/Employee"
}
}
});
//add relationship between order table and customer table
dataManager.addRelationship(orderTable, "CustomerId", "customer", customerTable, "Id", "orders");
dataManager.addRelationship(orderTable, "EmployeeId", "employee", employeeTable, "Id", "orders");
//init a table sheet
var sheet = spread.addSheetTab(0, "TableSheet1", GC.Spread.Sheets.SheetType.tableSheet);
sheet.options.allowAddNew = false; //hide new row
//bind a view to the table sheet
var addressStyle = {
formatter: 'Ship To: {{=CONCAT(@.ShipAddress, ", ", @.ShipCity)}}'
};
var formulaRule = {
ruleType: "formulaRule",
formula: "@>50",
style: {
backColor: "pink"
}
};
var multiSelectStyle = {
formatter: '{{=CONCAT([@customer.CompanyName], ", ", [@customer.ContactName])}}', // convert the object to string
};
var myView = orderTable.addView("myView", [
{ value: "Id", width: 60}, //set column width 100px
{ value: "OrderDate", width: 120, style: { formatter: "MM/dd/yyyy", hAlign: "center", cellButtons: [{
command: "openDateTimePicker",
imageType: "dropdown",
useButtonStyle: true,
}]}},
{ value: "Freight", width: 100, conditionalFormats: [formulaRule], style: {backColor: "white"}},
/**
* customer.companyName - this is a related field from the customer table
* update the customerId in orderTable by select from customer table.
*/
{ caption: "Customer", value: "CustomerId", width: 350, style: multiSelectStyle},
/**
* [=@] this column will contain the full row as a value, the formatter formula will extract the shipping address from the full row.
* Format functions can be used to customize column display value
* use star-size "2*" to set column width relative to the viewport width
*/
{ value: "=[@]", caption: "Address", style: addressStyle, width: 450 },
/**
* The formatter formula will extract the properties from the full row.
* Format functions can be used to customize column display value.
*/
{ caption: "Employee", value: "employee", width: 250 , style: { formatter: '{{=[@employee.FirstName] & " " & [@employee.LastName]}} ({{=[@ShipRegion]}})'} },
]);
myView.fetch().then(function() {
sheet.setDataView(myView);
});
spread.resumePaint();
}
function getBaseApiUrl() {
return window.location.href.match(/http.+spreadjs\/SpreadJSTutorial\//)[0] + 'server/api';
}
<!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">
<!-- Promise Polyfill for IE, https://www.npmjs.com/package/promise-polyfill -->
<script src="https://cdn.jsdelivr.net/npm/promise-polyfill@8/dist/polyfill.min.js"></script>
<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-tablesheet/dist/gc.spread.sheets.tablesheet.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 id="optionContainer" class="optionContainer">
</div>
</div>
</html>
.sample-tutorial {
position: relative;
height: 100%;
overflow: hidden;
}
body {
position: absolute;
top: 0;
bottom: 0;
left: 0;
right: 0;
}
.sample-spreadsheets {
width: 100%;
height: 100%;
overflow: hidden;
float: left;
}