Home > DMT_Schematic > modifySchematicPageTitleBlock

DMT_Schematic.modifySchematicPageTitleBlock() method

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

修改原理图图页明细表

签名

function modifySchematicPageTitleBlock(
	showTitleBlock?: boolean,
	titleBlockData?: Record<
		string,
		{ showTitle?: undefined | false | true; showValue?: undefined | false | true; value?: any }
	>,
): Promise<boolean>;

参数名

参数	类型	描述
showTitleBlock	boolean	（可选） 是否显示明细表，不定义将保持当前状态
titleBlockData	Record<string, { showTitle?: undefined | false | true; showValue?: undefined | false | true; value?: any }>	（可选） 需要修改的明细项及其修改的值

返回值

Promise<boolean>

修改操作是否成功，如若未传入 showTitleBlock 和 titleBlockData 将返回 false；请注意，如若存在无法识别的明细项但程序并未出错，将返回 true 的结果，因为无法识别的明细项被忽略

备注

titleBlockData 仅需要传入任何需要修改的明细项作为 key，并传入其需要修改的值，任何无法识别的明细项将被忽略，任何未传入的项和值将保持默认状态

示例

// 1. 创建专用测试原理图并打开自带图页 p1，让焦点落到目标页上
const schematicUuid = await eda.dmt_Schematic.createSchematic();
await new Promise(r => setTimeout(r, 1500));
const info = await eda.dmt_Schematic.getSchematicInfo(schematicUuid);
const pageUuid = info.page[0].uuid;
await eda.dmt_EditorControl.openDocument(pageUuid);
await new Promise(r => setTimeout(r, 1000));

// 2. 修改明细表：显示明细表，并把"公司"改为示例值（三个字段缺一不可）
const modified = await eda.dmt_Schematic.modifySchematicPageTitleBlock(true, {
	Company: { showTitle: true, showValue: true, value: '嘉立创示例科技' },
});
console.log('modified:', modified);

// 3. 等 1.5s 同步，回读验证明细项已更新
await new Promise(r => setTimeout(r, 1500));
const after = await eda.dmt_Schematic.getSchematicPageInfo(pageUuid);
console.log('showTitleBlock:', after?.showTitleBlock);
console.log('company:', after?.titleBlockData?.Company?.value);
console.log('modifyVerified:', after?.titleBlockData?.Company?.value === '嘉立创示例科技');

// 4. 清理测试原理图，保持工程整洁
await new Promise(r => setTimeout(r, 1000));
const deleted = await eda.dmt_Schematic.deleteSchematic(schematicUuid);
console.log('deleted:', deleted);