单元格批注基础应用

SpreadJS 支持为单元格添加批注,用于补充说明单元格内容。批注会在单元格右上角显示红色标记,鼠标悬停时显示批注内容,帮助用户更好地理解表格数据。批注功能适用于数据说明、审核标记、提示信息等场景,提升表格的可读性和交互体验。

概述 本 Demo 展示了如何在 SpreadJS 中为单元格添加批注。Demo 中包含两部分:初始化时创建的一个带批注的合并单元格,以及交互式添加批注的功能,用户可以通过输入框指定批注的位置和内容。 实现思路 初始化 SpreadJS Workbook 实例并获取活动工作表 使用 addSpan 方法合并单元格,并设置单元格的值 调用 comments.add 方法为合并单元格添加批注 为按钮绑定点击事件,获取用户输入的行索引、列索引和批注文本 在用户指定位置动态添加批注 代码解析 初始化时添加批注 这段代码演示了批注的基本用法。首先通过 addSpan 方法合并单元格,然后使用 setValue 设置单元格显示的文本,最后调用 comments.add 方法在指定位置添加批注。批注添加后,单元格右上角会显示红色标记。 交互式添加批注 这段代码为按钮绑定点击事件。当用户点击按钮时,从输入框获取行索引、列索引和批注文本,然后在指定单元格添加批注。这展示了批注功能的动态添加能力。 运行效果 页面加载后,第1行第1列的合并单元格右上角显示红色批注标记,鼠标悬停时显示"新批注!"文本 在右侧输入框中输入行索引、列索引和批注文本,点击"添加批注"按钮 在指定单元格位置会显示批注标记,鼠标悬停时显示用户输入的批注内容 API 参考 comments.add 方法 row:单元格的行索引 col:单元格的列索引 text:批注的文本内容 返回值:Comment 对象,可用于进一步设置批注样式
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, "单元格右上角有一条批注"); sheet.comments.add(1, 1, "新批注!"); 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, '新批注'); var text = document.getElementById("txtComment").value; sheet.comments.add(row, col, text); }) };
<!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-software/spread-sheets/styles/gc.spread.sheets.excel2013white.css"> <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-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"> <label for="txtRowIndex">行索引:</label> <input id="txtRowIndex" type="text" value="5" /> </div> <div class="option-row"> <label for="txtColumnIndex">列索引:</label> <input id="txtColumnIndex" type="text" value="2" /> </div> <div class="option-row"> <label for="txtComment">批注文本:</label> <input id="txtComment" type="text" value="批注演示" /> </div> <div class="option-row"> <input type="button" id="btnAddComment" value="添加批注" /> </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; }