Home > PCB_Event > addMouseEventListener

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

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

Parameters

Parameter	Type	Description
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	(Optional) 是否仅监听一次

Returns

void

Remarks

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