Home > SCH_PrimitiveWire > modify

SCH_PrimitiveWire.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 Wire

Signature

function modify(
	primitiveId: string | ISCH_PrimitiveWire,
	property: {
		line?: undefined | number[] | number[][];
		net?: undefined | string;
		color?: 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_PrimitiveWire | undefined>;

Parameters

Parameter	Type	Description
primitiveId	string | ISCH_PrimitiveWire	Wire primitive ID or Wire primitive object
property	{ line?: undefined | number[] | number[][]; net?: undefined | string; color?: 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_PrimitiveWire | undefined>

Wire primitive object

Example

// 1. 创建待修改的测试导线（随机坐标避免与画布已有导线重合）
const x = 2000 + Math.floor(Math.random() * 8000);
const y = 2000 + Math.floor(Math.random() * 8000);
const wire = await eda.sch_PrimitiveWire.create([x, y, x + 400, y], 'SIG_A', '#FF0000', 6, 1);
const wireId = wire.getState_PrimitiveId();

// 2. 读取修改前的网络、线宽与颜色
const beforeNet = wire.getState_Net();
const beforeWidth = wire.getState_LineWidth();
const beforeColor = wire.getState_Color();

// 3. 批量修改：网络 SIG_A → SIG_B、线宽 6 → 10、颜色改为绿色，路径改为向右再向上的 L 形
await eda.sch_PrimitiveWire.modify(wireId, {
	line: [[x, y, x + 400, y], [x + 400, y, x + 400, y + 200]],
	net: 'SIG_B',
	lineWidth: 10,
	color: '#00AA00',
});

// 4. modify 返回后需要重新 get() 才能读到画布上的最新值（Line 是规格化坐标，只打印不断言）
const refreshed = await eda.sch_PrimitiveWire.get(wireId);

// 5. 修改类保留现场，供观察修改结果
console.log('primitiveId:', wireId);
console.log('net:', beforeNet, '→', refreshed.getState_Net());
console.log('lineWidth:', beforeWidth, '→', refreshed.getState_LineWidth());
console.log('color:', beforeColor, '→', refreshed.getState_Color());
console.log('line:', JSON.stringify(refreshed.getState_Line()));