概述
本 Demo 展示了如何在 TableSheet 的数据源模式中使用触发器公式（Trigger Formula）实现数据的自动计算和处理。Demo 中配置了多个触发器,演示了不同场景的应用:自动格式化输入文本、记录创建和更新时间、根据其他字段计算金额、提供默认值等。
实现思路
创建订单表（orderTable）和客户表（customerTable）,并建立关联关系
在订单表的 schema.columns 中为多个字段配置 trigger 属性
定义自定义函数 ACTIVEUSER,用于获取当前更新用户
创建视图并绑定到 TableSheet
代码解析
配置触发器公式
触发器公式通过 GC.Data.ITriggerFormulaOption 接口配置,包含三个核心属性:
这段代码为 SKU 列配置了触发器。当新建或更新数据时,自动将输入的 SKU 文本转换为大写并去除首尾空格。fields 属性指定当 SKU 字段发生变化时触发公式。
记录创建和更新时间
OrderDate 使用 when: "onNew",仅在新建订单时记录创建日期。lastUpdatedTime 使用 fields: "*",表示任何字段更新时都会触发公式,记录更新时间。
复杂计算和条件逻辑
这个触发器演示了复杂公式的应用。使用 LET 函数计算金额,当数量超过 30 时自动应用 8 折优惠。fields 指定单价和数量字段变化时触发计算。
使用自定义函数
触发器公式支持使用自定义函数。Demo 中定义了 ACTIVEUSER 函数,返回随机用户名模拟当前更新用户。
通过继承 GC.Spread.CalcEngine.Functions.Function 类并实现 evaluate 方法,可以创建自定义函数。使用 defineGlobalCustomFunction 全局注册后即可在触发器公式中使用。
提供默认值
当订单电话为空时,自动从关联的客户表中获取电话号码。这展示了触发器公式如何引用关联数据。
运行效果
新建订单时,OrderDate 自动记录当前日期
输入 SKU 文本后,自动转换为大写格式
修改单价或数量时,Amount 自动重新计算,数量超过 30 时享受折扣
任何字段更新后,lastUpdatedTime 和 lastUpdateUser 自动记录更新信息
如果订单电话为空,会自动填充对应客户的电话号码
API 参考
GC.Data.ITriggerFormulaOption 接口
when: 必填,指定触发时机
"onNew": 仅在新建数据时触发
"onNewAndUpdate": 在新建和更新数据时都触发
formula: 必填,要应用的公式字符串
fields: 可选,指定哪些字段变化会触发公式
"*": 表示所有字段
"field1,field2": 用逗号分隔的字段列表
当 when 为 "onNew" 时可省略
/*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 updateOrderWithTriggerFormulas(spread) {
var dataManager = spread.dataManager();
var orderTable = dataManager.addTable("orderTable", {
remote: {
read: {
url: "$DEMOROOT$/spread/source/data/orderAmountTrigger.csv"
}
},
schema: {
type: "csv",
columns: {
SKU: {
dataType: "string",
trigger: {
when: "onNewAndUpdate",
formula: "=UPPER(TRIM([@SKU]))", // Format the input SKU text
fields: "SKU" // If the SKU field be inputted, trigger the formula to format the input text
}
},
OrderDate: {
dataType: "date",
trigger: {
when: "onNew", // When an order added, records the order created date
formula: "=TODAY()"
}
},
lastUpdatedTime: {
dataType: "date",
trigger: {
when: "onNewAndUpdate",
formula: "=NOW()",
fields: "*" // When any field be updated or the order be added, records the order updated time
}
},
lastUpdateUser: {
dataType: "string",
trigger: {
when: "onNewAndUpdate",
formula: "=ACTIVEUSER()", // The user could determine how to getting the current updated user by them self
fields: "*" // When any field be updated or the order be added, records the updated user
}
},
OrderPhone: {
dataType: "string",
trigger: {
when: "onNewAndUpdate",
formula: "=IF(ISBLANK([@OrderPhone]),[@customer.Phone],[@OrderPhone])",
fields: "CustomerId,OrderPhone"// Provide the customer phone when the order phone is blank
}
},
Amount: {
dataType: "number",
trigger: {
when: "onNewAndUpdate",
formula: "=LET(amount, [@UnitPrice] * [@Quantity], IF([@Quantity] > 30, amount * 0.8, amount))",
fields: "UnitPrice,Quantity" // When the UnitPrice or Quantity fields updated or the order be added, Amount field will get a calculated result automatically
}
},
CustomerId: {
lookup: {
name: 'customer', columns: [
{ value: "Id", width: 60 },
{ value: "CompanyName", width: 200 },
{ value: "ContactName", width: 140 },
{ value: "ContactTitle", width: 140 }
]
}
},
Quantity: { dataType: "number" },
UnitPrice: { dataType: "number" },
}
}
});
var customerTable = dataManager.addTable("customerTable", {
remote: {
read: {
url: getBaseApiUrl() + "/Customer"
}
}
});
//add relationship between order table, customer table table
dataManager.addRelationship(orderTable, "CustomerId", "customer", customerTable, "Id", "orders");
//init a table sheet
var sheet = spread.addSheetTab(0, "TableSheet1", GC.Spread.Sheets.SheetType.tableSheet);
var myView = orderTable.addView("myView", [
{ value: "Id", width: 60, visible: false },
{ value: "SKU", width: 120 },
{ value: "Quantity", width: 100 },
{ value: "UnitPrice", width: 100 },
{ value: "Amount", width: 100 },
{ value: "CustomerId", caption: 'Customer', width: 120, defaultValue: 'ALFKI', visible: false },
{ value: "OrderPhone", caption: 'Order Phone', width: 120 },
{ value: "OrderDate", width: 150, readonly: true, visible: false },
{ value: "lastUpdatedTime", width: 180, readonly: true, visible: false },
{ value: "lastUpdateUser", width: 150, readonly: true, visible: false },
]);
myView.fetch().then(function() {
sheet.setDataView(myView);
});
spread.resumePaint();
}
function addActiveUserFunction() {
function ActiveUserFunction() {
this.name = "ACTIVEUSER";
}
ActiveUserFunction.prototype = new GC.Spread.CalcEngine.Functions.Function("ACTIVEUSER", 0, 0, { name: "ACTIVEUSER" });
ActiveUserFunction.prototype.evaluate = function() {
let fakeNames = [
"Warner",
"Guerrero",
"Mathis",
"Morton",
"Knight",
"Cox",
"Keller",
"Pena",
"Maxwell",
"Ford",
"Bass",
"Morton",
"Parsons"
];
return fakeNames[Math.floor(Math.random() * fakeNames.length)];
};
GC.Spread.CalcEngine.Functions.defineGlobalCustomFunction("ACTIVEUSER", new ActiveUserFunction());
}
function getBaseApiUrl() {
return window.location.href.match(/http.+spreadjs\/SpreadJSTutorial\//)[0] + 'server/api';
}
function initSpread(spread) {
spread.suspendPaint();
spread.options.autoFitType = GC.Spread.Sheets.AutoFitType.cellWithHeader;
addActiveUserFunction();
updateOrderWithTriggerFormulas(spread);
spread.resumePaint();
}
<!doctype html>
<html style="height:100%;font-size:14px;">
<head>
<meta charset="utf-8" />
<meta name="spreadjs culture" content="zh-cn" />
<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;
margin: 0;
}
.sample-spreadsheets {
width: 100%;
height: 100%;
overflow: hidden;
float: left;
}
