简体中文
Home > SYS_Event > addProgressBarEventListener
SYS_Event.addProgressBarEventListener() method
此 API 当前处于 BETA 预览状态,希望得到开发者的反馈。它的任何功能都可能在接下来的开发进程中被修改,请不要将它用于任何正式环境。
新增进度条事件监听
签名
typescript
function addProgressBarEventListener(
id: string,
callFn: (props: ISYS_ProgressBarEventProps) => void | Promise<void>,
onlyOnce?: boolean,
actions?: ESYS_ProgressBarAction[],
): void;1
2
3
4
5
6
2
3
4
5
6
参数名
参数 | 类型 | 描述 |
|---|---|---|
id | string | 事件 ID,用以防止重复注册事件 |
callFn | (props: ISYS_ProgressBarEventProps) => void | Promise<void> | 事件触发时的回调函数,收到的参数见 ISYS_ProgressBarEventProps |
onlyOnce | boolean | (可选) 是否仅监听一次 |
actions | (可选) 可选,仅监听指定操作类型的事件;不传时监听全部操作 |
返回值
void
备注
在进度条整个生命周期的各阶段触发回调,同一个进度条会依次产生多个事件
单条进度条的典型触发序列为 start → 若干次 update → complete,或 start → 若干次 update → close / destroy,即回调会被多次调用;不需要全部阶段时请用 actions 过滤
编辑器内任意进度条都会触发本事件,包括扩展通过 SYS_LoadingAndProgressBar.showProgressBar() 创建的,以及编辑器内部功能(如打开工程、导出等)创建的;可依据 progressBarId / title 自行过滤
本接口仅扩展有效,在独立脚本环境内调用将始终 throw Error
同一 id 重复注册会覆盖此前的监听
ADD since EDA v4.1.103
示例
javascript
const listenerId = '嘉立创示例_进度条事件';
// 1. 先注册监听,再显示进度条
// 回调会在 start / update / complete(或 close、destroy)各阶段被多次调用,按 action 分发处理
eda.sys_Event.addProgressBarEventListener(listenerId, (props) => {
switch (props.action) {
case 'start':
console.log('进度条开始:', props.progressBarId, props.title);
break;
case 'update':
console.log('进度更新:', props.progress);
break;
case 'complete':
console.log('任务完成');
break;
case 'close':
console.log('用户关闭,此时进度:', props.progress);
break;
case 'destroy':
console.log('进度条被主动销毁');
break;
}
});
eda.sys_LoadingAndProgressBar.showProgressBar(30, '嘉立创示例 正在处理');
// 2. 只关心用户关闭时用 actions 过滤,此时回调只会被触发一次
// eda.sys_Event.addProgressBarEventListener(listenerId, props => {}, false, ['close']);
// 3. 监听会持续存在;任务结束或不再需要时再移除
// eda.sys_Event.removeEventListener(listenerId);1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30