文档 • API • UI• 事件

RED.events

编辑器会发出事件，组件可以监听这些事件以根据需要做出响应。

注意：此列表之外的任何事件都应视为私有事件，可能在不通知的情况下更改，不建议用于一般用途。

为给定事件注册一个新的处理程序。

RED.events.on("nodes:add", function(node) {
    console.log("A node has been added to the workspace!")
})

删除之前注册的事件处理程序。

事件	有效载荷	描述
`deploy（部署）`		已部署新流程
`login（登录）`	`"username"（用户名）`	用户已登录编辑器。如果未配置`adminAuth`，则不会发出此事件
`view:selection-changed（视图：选择已更改）`	`{<selection object>}`	工作区中的当前选择已更改
`workspace:change（工作区：更改）`	`{ old: "<previous-workspace-id>", workspace: "<new-workspace-id>" }`	工作区已切换到不同的选项卡
`workspace:clear（工作区：清除）`		工作区已清除 - 这在切换项目时发生。
`workspace:dirty（工作区：脏）`	`{ dirty:<boolean> }`	编辑器的“脏”状态已更改。“脏”表示存在未部署的更改。
`workspace:hide（工作区：隐藏）`	`{ workspace: <workspace-id> }`	选项卡已隐藏
`workspace:show（工作区：显示）`	`{ workspace: <workspace-id> }`	之前隐藏的选项卡已显示

事件	有效载荷	描述
`flows:add（流程：添加）`	`{<flow object>}`	已添加新流程
`flows:change（流程：更改）`	`{<flow object>}`	流程的属性已更改
`flows:remove（流程：移除）`	`{<flow object>}`	流程已移除
`flows:reorder（流程：重新排序）`	`[<Array of flow ids]`	流程已重新排序
`groups:add（组：添加）`	`{<group object>}`	已添加新组
`groups:change（组：更改）`	`{<group object>}`	组的属性已更改
`groups:remove（组：移除）`	`{<group object>}`	组已移除
`links:add（链接：添加）`	`{<link object>}`	已添加新链接
`links:remove（链接：移除）`	`{<link object>}`	链接已移除
`nodes:add（节点：添加）`	`{<node object>}`	已添加新节点
`nodes:change（节点：更改）`	`{<node object>}`	节点的属性已更改
`nodes:remove（节点：移除）`	`{<node object>}`	节点已移除
`nodes:reorder（节点：重新排序）`	`{z:"<flow-id>", nodes:[<Array of node ids>]}`	流程上的节点已重新排序
`subflows:add（子流程：添加）`	`{<subflow object>}`	已添加新子流程
`subflows:change（子流程：更改）`	`{<subflow object>}`	子流程的属性已更改
`subflows:remove（子流程：移除）`	`{<subflow object>}`	子流程已移除

事件	有效载荷	描述
`registry:module-updated（注册表：模块已更新）`	`{module:"<module-name>", version:"<module-version>"}`	模块已更新到新版本
`registry:node-set-added（注册表：节点集已添加）`	`{<node-set object>}`	已向调色板添加新节点集
`registry:node-set-disabled（注册表：节点集已禁用）`	`{<node-set object>}`	节点集已禁用
`registry:node-set-enabled（注册表：节点集已启用）`	`{<node-set object>}`	节点集已启用
`registry:node-set-removed（注册表：节点集已移除）`	`{<node-set object>}`	节点集已移除
`registry:node-type-added（注册表：节点类型已添加）`	`"node-type"（节点类型）`	已向调色板添加新节点
`registry:node-type-removed（注册表：节点类型已移除）`	`"node-type"（节点类型）`	节点已从调色板中移除
`registry:plugin-added（注册表：插件已添加）`	`"plugin-id"（插件 ID）`	已添加插件