Home > PCB_Event > addRealTimeDrcResultEventListener

PCB_Event.addRealTimeDrcResultEventListener() 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 real-time DRC result event listener

Signature

public addRealTimeDrcResultEventListener(id: string, eventType: 'all', callFn: (eventType: undefined, props: [{ drcResult: any }]) => void | Promise<void>): void;

Parameters

Parameter	Type	Description
id	string	Event ID, used to prevent duplicate event registration
eventType	'all'	Event type
callFn	(eventType: undefined, props: [{ drcResult: 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 = '嘉立创示例_drc_result';

// 1. 注册实时 DRC 结果监听，eventType 固定为 'all'
eda.pcb_Event.addRealTimeDrcResultEventListener(
  listenerId,
  'all',
  (eventType, props) => {
    // 回调在实时 DRC 检出违规时触发；props 是 DRC 结果数组
    console.log('drcResult:', JSON.stringify(props));
  }
);

// 2. 回读确认注册成功
const registered = eda.pcb_Event.isEventListenerAlreadyExist(listenerId);
console.log('registered:', registered);

// 3. 清理监听
const removed = eda.pcb_Event.removeEventListener(listenerId);
console.log('removed:', removed);