Home > PCB_PrimitiveImage > delete

PCB_PrimitiveImage.delete() method

此 API 当前处于 BETA 预览状态，希望得到开发者的反馈。它的任何功能都可能在接下来的开发进程中被修改，请不要将它用于任何正式环境。

删除图像

签名

function delete(primitiveIds: string | IPCB_PrimitiveImage | Array<string> | Array<IPCB_PrimitiveImage>): Promise<boolean>;

参数名

参数	类型	描述
primitiveIds	string | IPCB_PrimitiveImage | Array<string> | Array<IPCB_PrimitiveImage>	图像的图元 ID 或图像图元对象

返回值

Promise<boolean>

删除操作是否成功

示例

// 1. 创建两个待删除的测试图像（随机坐标避免与画布已有图像重合）
const x = 2000 + Math.floor(Math.random() * 100000);
const y = 2000 + Math.floor(Math.random() * 100000);
const cp = eda.pcb_MathPolygon.createComplexPolygon([0, 0, 'L', 200, 0, 200, 150, 0, 150]);
const image1 = await eda.pcb_PrimitiveImage.create(x, y, cp, 1, 400, 300, 0, false, false);
const image2 = await eda.pcb_PrimitiveImage.create(x, y + 1000, cp, 1, 400, 300, 0, false, false);

// 2. 记录删除前的图像数量
const beforeCount = (await eda.pcb_PrimitiveImage.getAll()).length;

// 3. 以 ID 数组形式批量删除两个图像
const deleted = await eda.pcb_PrimitiveImage.delete([
	image1.getState_PrimitiveId(),
	image2.getState_PrimitiveId()
]);

// 4. 删除类保留现场（图元已删除，不恢复）
const afterCount = (await eda.pcb_PrimitiveImage.getAll()).length;

console.log('deleted:', deleted);
console.log('beforeCount:', beforeCount, '→ afterCount:', afterCount);