Home > SCH_PrimitiveText > modify

SCH_PrimitiveText.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 Text

Signature

function modify(
	primitiveId: string | ISCH_PrimitiveText,
	property: {
		x?: undefined | number;
		y?: undefined | number;
		content?: undefined | string;
		rotation?: undefined | number;
		textColor?: undefined | null | string;
		fontName?: undefined | null | string;
		fontSize?: undefined | null | number;
		bold?: undefined | false | true;
		italic?: undefined | false | true;
		underLine?: undefined | false | true;
		alignMode?:
			| undefined
			| ESCH_PrimitiveTextAlignMode.LEFT_TOP
			| ESCH_PrimitiveTextAlignMode.LEFT_MIDDLE
			| ESCH_PrimitiveTextAlignMode.LEFT_BOTTOM
			| ESCH_PrimitiveTextAlignMode.CENTER_TOP
			| ESCH_PrimitiveTextAlignMode.CENTER
			| ESCH_PrimitiveTextAlignMode.CENTER_BOTTOM
			| ESCH_PrimitiveTextAlignMode.RIGHT_TOP
			| ESCH_PrimitiveTextAlignMode.RIGHT_MIDDLE
			| ESCH_PrimitiveTextAlignMode.RIGHT_BOTTOM;
	},
): Promise<ISCH_PrimitiveText | undefined>;

Parameters

Parameter	Type	Description
primitiveId	string | ISCH_PrimitiveText	Primitive ID
property	{ x?: undefined | number; y?: undefined | number; content?: undefined | string; rotation?: undefined | number; textColor?: undefined | null | string; fontName?: undefined | null | string; fontSize?: undefined | null | number; bold?: undefined | false | true; italic?: undefined | false | true; underLine?: undefined | false | true; alignMode?: undefined | ESCH_PrimitiveTextAlignMode.LEFT_TOP | ESCH_PrimitiveTextAlignMode.LEFT_MIDDLE | ESCH_PrimitiveTextAlignMode.LEFT_BOTTOM | ESCH_PrimitiveTextAlignMode.CENTER_TOP | ESCH_PrimitiveTextAlignMode.CENTER | ESCH_PrimitiveTextAlignMode.CENTER_BOTTOM | ESCH_PrimitiveTextAlignMode.RIGHT_TOP | ESCH_PrimitiveTextAlignMode.RIGHT_MIDDLE | ESCH_PrimitiveTextAlignMode.RIGHT_BOTTOM }	Modify Parameter

Returns

Promise<ISCH_PrimitiveText | undefined>

Text primitive object

Example

// 1. 创建待修改的测试文本：默认样式（随机坐标避免重合）
const x = 2000 + Math.floor(Math.random() * 8000);
const y = 2000 + Math.floor(Math.random() * 8000);
const text = await eda.sch_PrimitiveText.create(x, y, '嘉立创示例_原始文本');
const textId = text.getState_PrimitiveId();

// 2. 记录修改前的内容、颜色与字号
const beforeContent = text.getState_Content();
const beforeColor = text.getState_TextColor();
const beforeFontSize = text.getState_FontSize();

// 3. 批量修改：平移位置、内容更新、颜色改蓝、字号 20、加粗
await eda.sch_PrimitiveText.modify(textId, {
	x: x + 200,
	y: y + 100,
	content: '嘉立创示例_修改后的文本',
	textColor: '#0000FF',
	fontSize: 20,
	bold: true,
});

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

// 5. 修改类保留现场，供观察修改结果
console.log('primitiveId:', textId);
console.log('content:', beforeContent, '→', refreshed.getState_Content());
console.log('textColor:', beforeColor, '→', refreshed.getState_TextColor());
console.log('fontSize:', beforeFontSize, '→', refreshed.getState_FontSize());
console.log('bold:', refreshed.getState_Bold());
console.log('position:', x, y, '→', refreshed.getState_X(), refreshed.getState_Y());