Home > SCH_PrimitiveArc > modify

SCH_PrimitiveArc.modify() 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.

Modify Arc

Signature

function modify(
	primitiveId: string | ISCH_PrimitiveArc,
	property: {
		startX?: undefined | number;
		startY?: undefined | number;
		referenceX?: undefined | number;
		referenceY?: undefined | number;
		endX?: undefined | number;
		endY?: undefined | number;
		color?: undefined | null | string;
		fillColor?: undefined | null | string;
		lineWidth?: undefined | null | number;
		lineType?:
			| undefined
			| null
			| ESCH_PrimitiveLineType.SOLID
			| ESCH_PrimitiveLineType.DASHED
			| ESCH_PrimitiveLineType.DOTTED
			| ESCH_PrimitiveLineType.DOT_DASHED;
	},
): Promise<ISCH_PrimitiveArc | undefined>;

Parameters

Parameter	Type	Description
primitiveId	string | ISCH_PrimitiveArc	Primitive ID
property	{ startX?: undefined | number; startY?: undefined | number; referenceX?: undefined | number; referenceY?: undefined | number; endX?: undefined | number; endY?: undefined | number; color?: undefined | null | string; fillColor?: undefined | null | string; lineWidth?: undefined | null | number; lineType?: undefined | null | ESCH_PrimitiveLineType.SOLID | ESCH_PrimitiveLineType.DASHED | ESCH_PrimitiveLineType.DOTTED | ESCH_PrimitiveLineType.DOT_DASHED }	Modify Parameter

Returns

Promise<ISCH_PrimitiveArc | undefined>

Arc primitive object

Example

// 1. 创建待修改的测试圆弧（随机坐标避免与画布已有圆弧重合）
const x = 2000 + Math.floor(Math.random() * 8000);
const y = 2000 + Math.floor(Math.random() * 8000);
const arc = await eda.sch_PrimitiveArc.create(x, y, x + 100, y + 100, x + 200, y, '#FF0000', null, 6, 1);
const arcId = arc.getState_PrimitiveId();

// 2. 读取修改前的线宽与颜色
const beforeWidth = arc.getState_LineWidth();
const beforeColor = arc.getState_Color();

// 3. 批量修改：终点右移、线宽 6 → 10、颜色改为绿色
await eda.sch_PrimitiveArc.modify(arcId, { endX: x + 400, lineWidth: 10, color: '#00AA00' });

// 4. modify 返回后需要重新 get() 才能读到画布上的最新值
const refreshed = await eda.sch_PrimitiveArc.get(arcId);

// 5. 修改类保留现场，供观察修改结果
console.log('primitiveId:', arcId);
console.log('lineWidth:', beforeWidth, '→', refreshed.getState_LineWidth());
console.log('color:', beforeColor, '→', refreshed.getState_Color());
console.log('endX:', x + 200, '→', refreshed.getState_EndX());