自定义函数

你可以在 SpreadJS 中添加自定义函数并在表单中使用它们。

<p>创建自定义函数时你需要从 <strong>GC.Spread.CalcEngine.Functions.Function</strong> 派生并重写一些关键方法,下面是示例代码:</p> <pre><code class="hljs js language-js"><span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">FactorialFunction</span>(<span class="hljs-params"></span>) </span>{ <span class="hljs-keyword">this</span>.name = <span class="hljs-string">'FACTORIAL'</span>; <span class="hljs-keyword">this</span>.maxArgs = <span class="hljs-number">1</span>; <span class="hljs-keyword">this</span>.minArgs = <span class="hljs-number">1</span>; } FactorialFunction.prototype = <span class="hljs-keyword">new</span> GC.Spread.CalcEngine.Functions.Function(); FactorialFunction.prototype.evaluate = <span class="hljs-function"><span class="hljs-keyword">function</span> (<span class="hljs-params">arg</span>) </span>{ <span class="hljs-comment">// your own evaluate content</span> <span class="hljs-keyword">var</span> factorial = <span class="hljs-keyword">new</span> FactorialFunction(); sheet.addCustomFunction(factorial); </code></pre> <p>当你添加完你的自定义函数后, 如果你想移除一个或者所有的自定义函数, 可以使用 <strong>removeCustomFunction</strong> 或者 <strong>clearCustomFunctions</strong> 函数。</p> <pre><code class="hljs js language-js">sheet.removeCustomFunction(<span class="hljs-string">'FACTORIAL'</span>); sheet.clearCustomFunctions(); </code></pre>
window.onload = function () { var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), { sheetCount: 1 }); initSpread(spread); }; function initSpread(spread) { var sheet = spread.getSheet(0); sheet.setValue(1, 1, 'Press \'Add a Custom Function\' button'); sheet.setColumnWidth(1, 225); sheet.setColumnWidth(2, 100); function FactorialFunction() { this.name = "FACTORIAL"; this.maxArgs = 1; this.minArgs = 1; } FactorialFunction.prototype = new GC.Spread.CalcEngine.Functions.Function(); FactorialFunction.prototype.evaluate = function (arg) { var result = 1; if (arguments.length === 1 && !isNaN(parseInt(arg))) { for (var i = 1; i <= arg; i++) { result = i * result; } return result; } return "#VALUE!"; }; var factorial = new FactorialFunction(); document.getElementById("addCustomFunction").addEventListener('click',function() { sheet.setValue(3, 1, 'Formula'); sheet.setValue(3, 2, '=factorial(5)'); sheet.setValue(4, 1, 'Result'); sheet.addCustomFunction(factorial); sheet.setFormula(4, 2, "=factorial(5)"); }); document.getElementById("removeCustomFunction").addEventListener('click',function() { sheet.removeCustomFunction("FACTORIAL"); sheet.recalcAll(true); }); };
<!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/spread-sheets/styles/gc.spread.sheets.excel2013white.css"> <script src="$DEMOROOT$/zh/purejs/node_modules/@grapecity/spread-sheets/dist/gc.spread.sheets.all.min.js" type="text/javascript"></script> <script src="$DEMOROOT$/zh/purejs/node_modules/@grapecity/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"> <input type="button" value="Add a Custom Function(factorial)" id="addCustomFunction" /> <input type="button" value="Remove the Custom Function(factorial)" id="removeCustomFunction"/> </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; overflow: auto; padding: 12px; height: 100%; box-sizing: border-box; background: #fbfbfb; } .option-row { margin-bottom: 12px; } input[type=button] { padding: 4px 6px; margin-bottom: 6px; } body { position: absolute; top: 0; bottom: 0; left: 0; right: 0; }