Home > PCB_Event > addCrossProbeSelectEventListener
PCB_Event.addCrossProbeSelectEventListener() method
此 API 当前处于 BETA 预览状态,希望得到开发者的反馈。它的任何功能都可能在接下来的开发进程中被修改,请不要将它用于任何正式环境。
新增交叉选择事件监听
签名
typescript
function addCrossProbeSelectEventListener(
id: string,
callFn: (props: any) => void | Promise<void>,
): void;1
2
3
4
2
3
4
参数名
参数 | 类型 | 描述 |
|---|---|---|
id | string | 事件 ID,用以防止重复注册事件 |
callFn | (props: any) => void | Promise<void> | 事件触发时的回调函数 |
返回值
void
备注
注意:本接口仅扩展有效,在独立脚本环境内调用将始终 throw Error
示例
javascript
const listenerId = '嘉立创示例_cross_probe';
// 1. 注册交叉选择事件监听(回调在用户执行交叉选中时触发,本例不依赖实际触发)
eda.pcb_Event.addCrossProbeSelectEventListener(listenerId, (props) => {
console.log('crossProbeSelect:', JSON.stringify(props));
});
// 2. 回读确认注册成功(同 id 重复注册会被防重机制忽略)
const registered = eda.pcb_Event.isEventListenerAlreadyExist(listenerId);
console.log('registered:', registered);
// 3. 清理监听
const removed = eda.pcb_Event.removeEventListener(listenerId);
console.log('removed:', removed);1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14