Home > SYS_HeaderMenu > removeSystemHeaderMenuItem

SYS_HeaderMenu.removeSystemHeaderMenuItem() 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.

移除系统顶部菜单项

Signature

removeSystemHeaderMenuItem(id: Array<string>, props?: {
        removeTheBeforeDivider?: boolean;
        removeTheAfterDivider?: boolean;
    }): Promise<boolean>;

Parameters

Parameter	Type	Description
id	Array<string>	菜单项 ID 树，将会按照数组顺序按层级匹配菜单项，并移除数组最后一位对应的菜单项
props	{ removeTheBeforeDivider?: boolean; removeTheAfterDivider?: boolean; }	(Optional) 其它参数，是否移除菜单项之前、之后的分隔线

Returns

Promise<boolean>

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

Remarks

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

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

本接口无法移除第一级菜单，id 数组请至少传递 2 个值

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

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

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