Home > PCB_Event > addMouseEventListener

PCB_Event.addMouseEventListener() method

此 API 当前处于 BETA 预览状态，希望得到开发者的反馈。它的任何功能都可能在接下来的开发进程中被修改，请不要将它用于任何正式环境。

新增鼠标事件监听

签名

function addMouseEventListener(
	id: string,
	eventType: 'all' | EPCB_MouseEventType,
	callFn: (
		eventType: EPCB_MouseEventType,
		props: [
			{
				primitiveId: string;
				primitiveType: EPCB_PrimitiveType;
				net?: undefined | string;
				designator?: undefined | string;
				parentComponentPrimitiveId?: undefined | string;
				parentComponentDesignator?: undefined | string;
			},
		],
	) => void | Promise<void>,
	onlyOnce?: boolean,
): void;

参数名

参数	类型	描述
id	string	事件 ID，用以防止重复注册事件
eventType	'all' | EPCB_MouseEventType	事件类型
callFn	(eventType: EPCB_MouseEventType, props: [{ primitiveId: string; primitiveType: EPCB_PrimitiveType; net?: undefined | string; designator?: undefined | string; parentComponentPrimitiveId?: undefined | string; parentComponentDesignator?: undefined | string }]) => void | Promise<void>	事件触发时的回调函数
onlyOnce	boolean	（可选） 是否仅监听一次

返回值

void

备注

注意：本接口仅扩展有效，在独立脚本环境内调用将始终 throw Error

示例

const listenerId = '嘉立创示例_mouse_event';

// 1. 注册鼠标事件监听，eventType 用 'all' 接收全部鼠标事件，onlyOnce 为 false 持续监听
eda.pcb_Event.addMouseEventListener(
	listenerId,
	'all',
	(eventType, props) => {
		// 回调在用户画布操作时触发；props 是命中图元的信息数组
		console.log('mouseEvent:', eventType, JSON.stringify(props));
	},
	false
);

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

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