English
Home > PCB_RightClickMenu > updateMenuItem
PCB_RightClickMenu.updateMenuItem() 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
typescript
function updateMenuItem(
target: EPCB_RightClickMenuTarget,
menuItemId: string,
patch: Partial<Omit<ISYS_RightClickMenuItem, 'id'>>,
): Promise<boolean>;1
2
3
4
5
2
3
4
5
Parameters
Parameter | Type | Description |
|---|---|---|
target | 目标右键菜单位置 | |
menuItemId | string | 待修改的菜单项 ID:内置项传其 ID;本扩展插入的项传插入时的原始 ID(自动定位)或 getMenu 返回的带前缀 ID |
patch | Partial<Omit<ISYS_RightClickMenuItem, 'id'>> | 需要修改的属性,未传入的属性保持不变 |
Returns
Promise<boolean>
是否修改成功,菜单项不存在时返回 false
Remarks
修改指定位置右键菜单中某个菜单项的部分属性,未传入的属性保持原值
既能修改扩展自己插入的菜单项,也能修改 EDA 内置菜单项;修改内置菜单项时仅影响显示与可用性,不会改变其原有动作
菜单项 ID 不允许修改,若 patch 内包含 id 将被忽略
本接口需要使用者启用扩展的外部交互权限,如若未启用将始终 throw Error ADD since EDA v5