自定义命令

SpreadJS 支持创建自定义命令并实现撤销/重做功能。通过事务机制,可以确保自定义操作能够被撤销和恢复,为用户提供完整的操作回退能力。适用于需要精细控制操作历史的表格应用场景。

概述 本 Demo 展示了如何创建一个支持撤销/重做的自定义命令。Demo 中实现了一个设置单元格背景色的自定义命令,用户可以执行该命令为选区设置背景色,并通过撤销/重做按钮或快捷键回退或恢复操作。 实现思路 创建 SpreadJS 工作簿实例,并获取撤销管理器用于后续的撤销/重做操作 定义自定义命令对象,设置 canUndo: true 标记命令支持撤销 在命令的 execute 函数中,通过 isUndo 参数判断是执行还是撤销操作 执行命令时:使用 startTransaction 开始事务,为选区设置背景色,然后使用 endTransaction 结束事务 撤销命令时:调用 undoTransaction 回退事务中的所有更改 使用命令管理器的 register 方法注册自定义命令 使用命令管理器的 execute 方法执行命令,传入选区信息和背景色参数 通过撤销管理器的 undo() 和 redo() 方法实现撤销和重做 代码解析 定义支持撤销的自定义命令 这段代码定义了一个自定义命令对象。canUndo: true 表示该命令支持撤销。execute 函数接收三个参数:spread(工作簿对象)、options(命令选项)、isUndo(是否为撤销操作)。 当 isUndo 为 true 时,调用 undoTransaction 撤销事务中的所有更改。否则,先调用 startTransaction 开始事务,然后为所有选区设置背景色,最后调用 endTransaction 结束事务。事务机制确保了所有更改被记录,可以被撤销。 注册和执行命令 使用 commandManager.register() 方法注册自定义命令,第一个参数是命令名称,第二个参数是命令对象。执行命令时,通过 commandManager.execute() 传入命令名称和参数,包括工作表名称、选区信息和背景色。 撤销和重做操作 通过 spread.undoManager() 获取撤销管理器,然后调用 undo() 和 redo() 方法实现撤销和重做功能。 运行效果 在表格中选择一个或多个区域 点击"设置背景色"按钮,选中的区域将被设置为绿色背景 点击"撤销"按钮,背景色设置将被撤销,恢复到原始状态 点击"重做"按钮,被撤销的背景色设置将重新应用 也可以使用键盘快捷键 Ctrl+Z 进行撤销,Ctrl+Y 进行重做 API 参考 GC.Spread.Sheets.Commands.startTransaction(context, options) 开始一个事务,事务中的所有更改将被记录,可以撤销。 context:操作的上下文,通常是 Workbook 对象 options:操作的选项,包含命令相关的信息 GC.Spread.Sheets.Commands.endTransaction(context, options) 结束当前事务,将事务中的所有更改保存到撤销栈中。 GC.Spread.Sheets.Commands.undoTransaction(context, options) 撤销事务中进行的所有更改。 commandManager.register(name, command) 向命令管理器注册自定义命令。 name:命令名称字符串 command:命令对象,包含 canUndo 和 execute 属性 commandManager.execute(options) 执行指定的命令。 options.cmd:命令名称 options:其他命令所需的参数 undoManager.undo() 撤销上一次操作。 undoManager.redo() 重做上一次被撤销的操作。
window.onload = function() { var spread = new GC.Spread.Sheets.Workbook(_getElementById('ss'), { sheetCount: 1 }); var undoManager = spread.undoManager(); _getElementById('undo').addEventListener('click', function() { undoManager.undo(); }); _getElementById('redo').addEventListener('click', function() { undoManager.redo(); }); _getElementById('setBackColor').addEventListener('click', function() { initSpread(spread); }); }; function initSpread(spread) { var sheet = spread.getActiveSheet(); var command = { canUndo: true, execute: function(spread, options, isUndo) { var Commands = GC.Spread.Sheets.Commands; if (isUndo) { Commands.undoTransaction(spread, options); return true; } else { Commands.startTransaction(spread, options); spread.suspendPaint(); var selections = options.selections; var value = options.backColor; selections.forEach(function(sel) { sheet.getRange(sel.row, sel.col, sel.rowCount, sel.colCount).backColor(value); }); spread.resumePaint(); Commands.endTransaction(spread, options); return true; } } }; var selections = sheet.getSelections(); var commandManager = spread.commandManager(); commandManager.register('changeBackColor', command); commandManager.execute({ cmd: 'changeBackColor', sheetName: spread.getSheet(0).name(), selections: selections, backColor: 'rgb(130, 188, 0)' }); } function _getElementById(id) { return document.getElementById(id); }
<!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"> <label>请选择一个区域,然后点击“设置背景色”按钮,将为该区域设置背景色。点击“撤销”和“重做”按钮可以撤销和重做设置背景色的操作。</label> <div class="option-row"> <input type="button" id="setBackColor" value="设置背景色" /> </div> <div class="option-row"> <input type="button" id="undo" value="撤销" /> </div> <div class="option-row"> <input type="button" id="redo" value="重做" /> </div> <hr> <div class="option-row"> <label>使用键盘快捷键 'Ctrl-Z' 撤销自定义操作,使用键盘快捷键 'Ctrl-Y' 重做自定义操作。</label> </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; padding: 12px; height: 100%; box-sizing: border-box; background: #fbfbfb; overflow: auto; } .option-row { font-size: 14px; padding: 5px; } label { display: block; margin-bottom: 6px; } input[type=button] { margin-top: 6px; display: block; } body { position: absolute; top: 0; bottom: 0; left: 0; right: 0; }