Home > SYS_HeaderMenu > removeSystemHeaderMenuItem

SYS_HeaderMenu.removeSystemHeaderMenuItem() method

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

移除系统顶部菜单项

签名

function removeSystemHeaderMenuItem(
	id: Array<string>,
	props?: {
		removeTheBeforeDivider?: undefined | false | true;
		removeTheAfterDivider?: undefined | false | true;
	},
): Promise<boolean>;

参数名

参数	类型	描述
id	Array<string>	菜单项 ID 树，将会按照数组顺序按层级匹配菜单项，并移除数组最后一位对应的菜单项；仅传递一个元素时移除对应的一级菜单
props	{ removeTheBeforeDivider?: undefined | false | true; removeTheAfterDivider?: undefined | false | true }	（可选） 其它参数，是否移除菜单项之前、之后的分隔线（仅在移除子菜单项时生效）

返回值

Promise<boolean>

移除操作是否成功，菜单已移除但分隔线未找到也会返回 true 的结果

备注

一旦菜单被移除，需要重启嘉立创 EDA 软件才可以恢复

本接口无法移除 接口导入的系统顶部菜单项

当 id 数组仅包含一个元素时，将移除对应的一级菜单；当 id 数组包含多个元素时，将按照数组顺序按层级匹配菜单项，并移除数组最后一位对应的子菜单项

本接口无法移除 **高级** 菜单本身及其下的任何子菜单

注意 1：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 throw Error

注意 2：本接口 **移除一级菜单** 为私有化部署版本专用功能，如若在其它版本调用将始终 throw Error

非公开接口使用提醒：本接口按原样提供，不提供参数的额外文档，参数可能在任何版本出现破坏性更改并不另行通知

示例

// 1. 先插入一个待移除的子菜单项（id 树：[一级菜单 ID, 新项 ID]）
const menuId = await eda.sys_HeaderMenu.insertSystemHeaderMenuItem('pcb', ['Tools', '嘉立创示例_待移除项'], {
	title: '嘉立创示例 待移除项',
});
console.log('待移除的菜单 ID：', menuId);

// 2. 移除该菜单项（id 树：[一级菜单 ID, insert 返回的重写 ID]）
const removed = await eda.sys_HeaderMenu.removeSystemHeaderMenuItem(['Tools', menuId]);
console.log('移除结果：', removed);