简体中文
Home > PCB_Document > beginCommandGroup
PCB_Document.beginCommandGroup() method
此 API 当前处于 BETA 预览状态,希望得到开发者的反馈。它的任何功能都可能在接下来的开发进程中被修改,请不要将它用于任何正式环境。
打开命令组
签名
typescript
function beginCommandGroup(name?: string): Promise<IPCB_CommandGroupResult>;1
参数名
参数 | 类型 | 描述 |
|---|---|---|
name | string | (可选) 命令组名称 |
返回值
Promise<IPCB_CommandGroupResult>
命令组开启结果
备注
打开后执行的所有写操作进入同一历史组,直到调用 commitCommandGroup 固化,或调用 rollbackCommandGroup 撤销
同一时间只允许存在一个打开的命令组
ADD since EDA v4.1.93
示例
javascript
const { groupId } = await eda.pcb_Document.beginCommandGroup('批量铺铜');
// ... 执行多项写操作 ...
await eda.pcb_Document.commitCommandGroup(groupId);
// 一次撤销整组
await eda.pcb_Document.undoLastCommandGroup();1
2
3
4
5
2
3
4
5