获取已用范围

SpreadJS 提供了 getUsedRange 方法,可以根据不同的数据类型(如数据、样式、标签等)快速获取工作表中已使用的单元格范围。这在需要批量设置样式、数据验证或条件格式时非常实用,能够帮助开发者快速定位操作区域,提升开发效率。

概述 本 Demo 展示了如何使用 getUsedRange 方法获取工作表中不同类型的已用范围。Demo 中演示了三种常见的范围类型:数据范围、样式范围和标签范围,并支持通过复选框组合查询多种类型的范围。 实现思路 在工作表中设置多种类型的内容:使用 setValue、setText 和 setArray 设置数据,使用 setStyle 设置样式,使用 setTag 设置标签 为部分单元格添加批注,用于标注标签位置 绑定三个复选框的 change 事件,分别对应数据、样式、标签三种范围类型 当复选框状态改变时,使用位运算符(|)组合选中的类型,调用 getUsedRange 获取范围 使用 setSelection 方法高亮显示获取到的范围,让用户直观看到结果 代码解析 设置多种类型的数据 这段代码在工作表中设置了三种不同类型的内容。数据包括单个值和数组,样式通过创建 Style 对象并设置背景色,标签则使用 setTag 方法为单元格添加标记。 组合多种范围类型 这段代码使用位运算符 | 将多种范围类型组合成一个值。getUsedRange 方法接受这个组合值,返回包含所有指定类型内容的最小矩形范围。如果找到范围,则使用 setSelection 高亮显示;否则选中 A1 单元格。 运行效果 工作表中显示了多种类型的数据:左侧有数字和文本数据,中间区域有数组数据,不同区域应用了不同的背景色样式,部分单元格带有标签和批注 勾选"数据"复选框,会选中所有包含数据的单元格的最小矩形范围 勾选"样式"复选框,会选中所有应用了样式的单元格的最小矩形范围 勾选"tag"复选框,会选中所有带有标签的单元格的最小矩形范围 可以同时勾选多个复选框,获取组合类型的范围 API 参考 getUsedRange 方法 type:可选参数,UsedRangeType 枚举值或组合值,指定要获取的范围类型 返回值:Range 对象,包含 row、col、rowCount、colCount 属性,表示已用范围的起始行、起始列、行数和列数;如果没有匹配的范围则返回 null UsedRangeType 枚举常用值 data:表示工作表的数据使用范围 style:表示工作表的单元格样式使用范围 tag:表示工作表的标签使用范围 all:表示工作表的所有使用范围类型 其他类型包括:formula(公式)、span(合并单元格)、chart(图表)、comment(批注)、table(表格)等
window.onload = function () { var spread = new GC.Spread.Sheets.Workbook(document.getElementById('ss')); var spreadNS = GC.Spread.Sheets; var sheet = spread.getSheet(0); let tagType, dataType, styleType; sheet.suspendPaint(); sheet.setValue(1, 2, 2014); sheet.setText(3, 1, 'setText'); sheet.setText(3, 2, '01/01/2014'); sheet.setText(5, 1, '0 Value'); sheet.setValue(5, 2, 0); sheet.setColumnWidth(2, 90); sheet.setColumnWidth(8, 120); sheet.setColumnWidth(9, 120); sheet.setValue(0, 7, 'setArray'); sheet.setArray(1, 7, [ ['ID', 'Phone Number', 'Address'], [1, '021-432378', 'Marbury Road'], [2, '021-432668', 'Chester Road'], [3, '021-432238', 'Gertt Road'], [4, '021-432533', 'Jnyliner Road'], [5, '021-432125', 'Approach Road'], [6, '021-432789', 'Jones Road'] ]); initStyle(sheet); sheet.setTag(10, 1, "tag1"); sheet.setTag(19, 4, "tag2"); var comment = new GC.Spread.Sheets.Comments.Comment(); comment.text("Cell B11 has tag"); comment.backColor("yellow"); comment.foreColor("green"); comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown); comment.autoSize(true); sheet.getCell(10, 1).comment(comment); comment = new GC.Spread.Sheets.Comments.Comment(); comment.text("Cell E20 has tag"); comment.backColor("yellow"); comment.foreColor("green"); comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown); comment.autoSize(true); sheet.getCell(19, 4).comment(comment); document.getElementById('tag-used-range').addEventListener('change', function () { tagType = this.checked; setUsedRange(dataType, styleType, tagType, sheet); }); document.getElementById('data-used-range').addEventListener('change', function () { dataType = this.checked; setUsedRange(dataType, styleType, tagType, sheet); }); document.getElementById('style-used-range').addEventListener('change', function () { styleType = this.checked; setUsedRange(dataType, styleType, tagType, sheet); }); sheet.resumePaint(); }; function initStyle(sheet) { let style = new GC.Spread.Sheets.Style(); style.backColor = '#c6c0ca'; for (let row = 1; row < 6; row++) { for (let col = 1; col < 3; col++) { sheet.setStyle(row, col, style); } } style = new GC.Spread.Sheets.Style(); style.backColor = '#bbd2cc'; for (let row = 1; row < 8; row++) { for (let col = 7; col < 10; col++) { sheet.setStyle(row, col, style); } } style = new GC.Spread.Sheets.Style(); style.backColor = '#fcd8dd'; for (let row = 10; row < 17; row++) { for (let col = 7; col < 10; col++) { sheet.setStyle(row, col, style); } } } function setUsedRange(dataType, styleType, tagType, sheet) { let type = 0; if (dataType) { type = type | GC.Spread.Sheets.UsedRangeType.data; } if (styleType) { type = type | GC.Spread.Sheets.UsedRangeType.style; } if (tagType) { type = type | GC.Spread.Sheets.UsedRangeType.tag; } if (type) { let usedRange = sheet.getUsedRange(type); if (usedRange) { sheet.setSelection(usedRange.row, usedRange.col, usedRange.rowCount, usedRange.colCount); return; } } sheet.setSelection(0, 0, 1, 1); }
<!doctype html> <html style="height:100%;font-size:14px;"> <head> <meta charset="utf-8" /> <meta name="spreadjs culture" content="zh-cn" /> <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"> <p>用户可以快速获取当前工作表中不同数据类型的最大范围</p> <p>勾选“数据”以获取包含数据的单元格的最大范围</p> <p>勾选“样式”以获取应用了样式的单元格的最大范围</p> <p>勾选“标签”以获取带有标签的单元格的最大范围</p> <input type="checkbox" class="usedRange" id="data-used-range"> <label for="data-used-range" class="usedRange">数据</label> <div class="mid-element"> <input type="checkbox" class="usedRange" id="style-used-range"> <label for="style-used-range" class="usedRange">样式</label> </div> <input type="checkbox" class="usedRange" id="tag-used-range"> <label for="tag-used-range" class="usedRange">tag</label> </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; padding: 12px; height: 100%; box-sizing: border-box; background: #fbfbfb; overflow: auto; } .option-row { font-size: 14px; padding: 5px; margin-top: 10px; } label { display: block; margin-bottom: 6px; margin-top: 6px; } input { padding: 4px 6px; } input[type=button] { margin-top: 6px; display: inline-block; width: 85px; } .usedRange { display: inline-block; } .mid-element { display: inline-block; margin:0 40px; } body { position: absolute; top: 0; bottom: 0; left: 0; right: 0; }