Home > SCH_Event > addPrimitiveEventListener

SCH_Event.addPrimitiveEventListener() method

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

新增图元事件监听

签名

function addPrimitiveEventListener(
	id: string,
	eventType: 'all' | ESCH_PrimitiveEventType,
	callFn: (
		eventType: ESCH_PrimitiveEventType,
		props: { primitiveIds: string[] },
	) => void | Promise<void>,
	onlyOnce?: boolean,
): void;

参数名

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

返回值

void

备注

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

示例

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

// 1. 注册图元事件监听，eventType 用 'all' 接收全部图元事件
eda.sch_Event.addPrimitiveEventListener(
	listenerId,
	'all',
	(eventType, props) => {
		// 回调在画布图元变化时触发
		console.log('primitiveEvent:', eventType, JSON.stringify(props?.primitiveIds));
	},
	false
);

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

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