Home > PCB_Event > addCrossProbeSelectEventListener

PCB_Event.addCrossProbeSelectEventListener() 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.

Add a cross-probe selection event listener

Signature

public addCrossProbeSelectEventListener(id: string, callFn: (props: any) => void | Promise<void>): void;

Parameters

Parameter	Type	Description
id	string	Event ID, used to prevent duplicate event registration
callFn	(props: any) => void | Promise<void>	The callback function triggered when the event fires

Returns

void

Remarks

Note: This API is only valid for extensions. Calling it in a standalone script environment will always throw Error

Example

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);