The option GC.Data.ITriggerFormulaOption can be added at the column in the data source schema. These are the properties available:
Name
Description
when
(Required) Indicates when to trigger:onNew: apply the formula on the data createdonNewAndUpdate: apply the formula on the data created or updated.
formula
(Required) Indicates the applied formula.
[fields]
(Optional) Indicates which fields could affect the formula to trigger:* - indicates that all data fieldfield1,field2,field3 - indicates a series of data fieldsthe property could be omitted when be onNew
The sample below shows how to config the triggers:
/*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\/demos\//)[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="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="stylesheet" type="text/css" href="$DEMOROOT$/en/purejs/node_modules/@mescius/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$/en/purejs/node_modules/@mescius/spread-sheets/dist/gc.spread.sheets.all.min.js" type="text/javascript"></script>
<script src="$DEMOROOT$/en/purejs/node_modules/@mescius/spread-sheets-tablesheet/dist/gc.spread.sheets.tablesheet.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;
}
