Home > SCH_PrimitiveCircle > delete

SCH_PrimitiveCircle.delete() method

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Delete the circle

Signature

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

Parameters

Parameter	Type	Description
primitiveIds	string | ISCH_PrimitiveCircle | Array<string> | Array<ISCH_PrimitiveCircle>	Primitive ID of the circle or the circle primitive object

Returns

Promise<boolean>

Delete Whether the operation is successful

Example

// 1. 创建两个待删除的测试圆（随机坐标避免重合，SCH 坐标单位 10mil）
const x = 2000 + Math.floor(Math.random() * 8000);
const y = 2000 + Math.floor(Math.random() * 8000);
const circle1 = await eda.sch_PrimitiveCircle.create(x, y, 100);
const circle2 = await eda.sch_PrimitiveCircle.create(x + 400, y, 150);

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

// 3. 分别以 ID 字符串和图元对象两种形式删除两个圆
const deleted1 = await eda.sch_PrimitiveCircle.delete(circle1.getState_PrimitiveId());
const deleted2 = await eda.sch_PrimitiveCircle.delete(circle2);

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

console.log('deleted by id:', deleted1);
console.log('deleted by object:', deleted2);
console.log('beforeCount:', beforeCount, '→ afterCount:', afterCount);