Overview

In SpreadJS you can add notes to a sheet using comments. Using comments can help you make a sheet easier to understand by providing additional context for the data it contains.

<p>To add a comment to a sheet, first create a comment and set some settings for it. Then you can use the <strong>add</strong> method to set a comment for the specified cell. For example:</p> <pre><code class="hljs js language-js"> sheet.comments.add(<span class="hljs-number">5</span>, <span class="hljs-number">5</span>, <span class="hljs-string">'new comment!'</span>); </code></pre> <p>Sometimes you want to remove the comment you added, as shown in the following example:</p> <pre><code class="hljs js language-js"> sheet.comments.remove(<span class="hljs-number">5</span>, <span class="hljs-number">5</span>); </code></pre> <p>After you add a comment to a cell, you can use the <strong>get</strong> method to get the comment, or use the <strong>all</strong> method to get all the comments in the sheet.</p> <pre><code class="hljs js language-js"> <span class="hljs-keyword">var</span> comment = sheet.comments.get(<span class="hljs-number">5</span>, <span class="hljs-number">5</span>); <span class="hljs-keyword">var</span> comments = sheet.comments.all(); </code></pre>
window.onload = function () { var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss")); initSpread(spread); }; function initSpread(spread) { var sheet = spread.getSheet(0); sheet.addSpan(1, 1, 1, 6); sheet.setValue(1, 1, "there is a comment on the upper right corner of the cell"); sheet.comments.add(1, 1, "new comment!"); document.getElementById("btnAddComment").addEventListener('click',function () { var row = parseInt(document.getElementById("txtRowIndex").value); var col = parseInt(document.getElementById("txtColumnIndex").value); var spreadNS = GC.Spread.Sheets; var sheet = spread.getSheet(0); sheet.setValue(row, col, 'new comment'); var text = document.getElementById("txtComment").value; sheet.comments.add(row, col, text); }) };
<!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"> <div class="option-row"> <label for="txtRowIndex">Row index:</label> <input id ="txtRowIndex" type ="text" value="5"/> </div> <div class="option-row"> <label for="txtColumnIndex">Column index:</label> <input id ="txtColumnIndex" type ="text" value="2"/> </div> <div class="option-row"> <label for="txtComment">Comment text:</label> <input id ="txtComment" type ="text" value="comment demo"/> </div> <div class="option-row"> <input type="button" id="btnAddComment" value="AddComment" /> </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; } label { display: inline-block; min-width: 90px; margin: 6px 0; } input { padding: 4px 6px; box-sizing: border-box; margin-bottom: 6px; } body { position: absolute; top: 0; bottom: 0; left: 0; right: 0; }