Array Formulas

Formulas may include functions that operate on arrays. An array formula is a formula that can perform multiple calculations on one or more of the items in an array.

<p>Array formulas are often referred to as CSE (Ctrl+Shift+Enter) formulas because instead of just pressing Enter, you press Ctrl+Shift+Enter to complete the formula.</p> <p>SpreadJS supports array constants in formulas. Use curly brackets ({ }) to enclose the array elements. Use a comma to separate elements within a row. Use a semicolon to separate rows within the array. Individual elements can be number values, text values, logical values, or error values. For example:</p> <pre><code class="hljs js language-js"> ={<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>} * {<span class="hljs-number">4</span>; <span class="hljs-number">5</span>; <span class="hljs-number">6</span>} <span class="hljs-comment">/* Returns an array as follows: [[4, 8, 12], [5, 10, 15], [6, 12, 18]] */</span> </code></pre> <p>You can use the <strong>setArrayFormula</strong> method to set an array formula, similar to the <strong>setFormula</strong> method. The formula text box shows the array formula surrounded by curly brackets ({ }).</p> <pre><code class="hljs js language-js"> <span class="hljs-comment">// set array formula use range</span> sheet.setArrayFormula(<span class="hljs-number">6</span>, <span class="hljs-number">4</span>, <span class="hljs-number">4</span>, <span class="hljs-number">3</span>, <span class="hljs-string">'=A1:A4*A1:C1'</span>); </code></pre>
var spreadNS = GC.Spread.Sheets; window.onload = function () { var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), { sheetCount: 1 }); initSpread(spread); }; function initSpread(spread) { spread.suspendPaint(); var fbx = new spreadNS.FormulaTextBox.FormulaTextBox(document.getElementById('formulaBar')); fbx.workbook(spread); var oldArrayRange; var arrayFormulaStyle = new spreadNS.Style(); arrayFormulaStyle.backColor = "#E0E0FF"; for (var i = 0; i < spread.sheets.length; i++) { (function (sheet1) { sheet1.bind(spreadNS.Events.SelectionChanged, null, function (args) { sheet1.suspendPaint(); var formulaBar = document.getElementById("formulaBar"); var formulaInfo = sheet1.getFormulaInformation(sheet1.getActiveRowIndex(), sheet1.getActiveColumnIndex()); if (oldArrayRange && (!formulaInfo || !formulaInfo.isArrayFormula || !formulaInfo.baseRange.equals(oldArrayRange))) { for (var r = oldArrayRange.row; r < oldArrayRange.row + oldArrayRange.rowCount; r++) { for (var c = oldArrayRange.col; c < oldArrayRange.col + oldArrayRange.colCount; c++) { sheet1.setStyle(r, c, null); } } oldArrayRange = null; } if (formulaInfo && formulaInfo.hasFormula) { var formula = "=" + formulaInfo.formula; formula = formulaInfo.isArrayFormula ? "{" + formula + "}" : formula; formulaBar.value=formula; if (formulaInfo.isArrayFormula && !formulaInfo.baseRange.equals(oldArrayRange)) { oldArrayRange = formulaInfo.baseRange; for (var r = oldArrayRange.row; r < oldArrayRange.row + oldArrayRange.rowCount; r++) { for (var c = oldArrayRange.col; c < oldArrayRange.col + oldArrayRange.colCount; c++) { sheet1.setStyle(r, c, arrayFormulaStyle); } } } } else { formulaBar.value=sheet1.getValue(sheet1.getActiveRowIndex(), sheet1.getActiveColumnIndex()); } sheet1.resumePaint(); }); })(spread.sheets[i]); } setBasic(spread.sheets[0]); spread.resumePaint(); }; function setBasic(sheet) { sheet.name("Simple"); sheet.setArray(0, 0, [[1, 2, 3, 4, 5, 6], [4, 5, 6], [7, 8, 9], [10, 11, 12]]); sheet.addSpan(0, 7, 4, 3); sheet.setValue(0, 7, "Set array fomular by:\n 1st select the cell / range;\n 2nd enter the formula;\n last press Ctrl+Shift+Enter."); setDescriptionStyle(sheet.getCell(0, 7)); sheet.setRowHeight(5, 40); sheet.addSpan(5, 0, 1, 3); sheet.setValue(5, 0, "Array formula use constants\n ex. ={1,2,3}*{4;5;6}"); setDescriptionStyle(sheet.getCell(5, 0)); sheet.setArrayFormula(6, 0, 3, 3, "={1,2,3}*{4;5;6}"); sheet.addSpan(5, 4, 1, 3); sheet.setValue(5, 4, "Array formula use range\n ex. =A1:A4*A1:C1"); setDescriptionStyle(sheet.getCell(5, 4)); sheet.setArrayFormula(6, 4, 4, 3, "=A1:A4*A1:C1"); sheet.addSpan(5, 8, 1, 4); sheet.setValue(5, 8, "Array formula use range & function\n ex. =SUM(A1:A4*A1:C1)"); setDescriptionStyle(sheet.getCell(5, 8)); sheet.setArrayFormula(6, 8, 4, 2, "=SUM(A1:A4*A1:C1)"); sheet.setRowHeight(11, 40); sheet.addSpan(11, 0, 1, 4); sheet.setValue(11, 0, "Array formula copy column range\n ex. =A1:A2"); setDescriptionStyle(sheet.getCell(11, 0)); sheet.setArrayFormula(12, 0, 2, 3, "=A1:A2"); sheet.addSpan(11, 5, 1, 3); sheet.setValue(11, 5, "Array formula copy row range\n ex. =A1:B1"); setDescriptionStyle(sheet.getCell(11, 5)); sheet.setArrayFormula(12, 5, 4, 2, "=A1:B1"); sheet.setRowHeight(17, 40); sheet.addSpan(17, 0, 1, 4); sheet.setValue(17, 0, "Array formula out of range value is #N/A:\n ex. ={1,2,3}*{4;5;6}"); setDescriptionStyle(sheet.getCell(17, 0)); sheet.setArrayFormula(18, 0, 4, 4, "={1,2,3}*{4;5;6}"); } function setDescriptionStyle(cell) { cell.wordWrap(true).backColor("Accent 5 80").vAlign(spreadNS.VerticalAlign.center); }
<!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/@grapecity/spread-sheets/styles/gc.spread.sheets.excel2013white.css"> <script src="$DEMOROOT$/en/purejs/node_modules/@grapecity/spread-sheets/dist/gc.spread.sheets.all.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"> <textarea id="formulaBar" rows="10" readonly="readonly"></textarea> </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; height: 100%; overflow: auto; padding: 12px; box-sizing: border-box; background: #fbfbfb; } textarea { width: 100%; box-sizing: border-box; } body { position: absolute; top: 0; bottom: 0; left: 0; right: 0; }