快速开始

本文为您介绍行为事件的注册、调试、发布、管理和配置。

重要

行为事件属于增值模块,需要额外购买,您可根据业务需求付费购买。

背景介绍

对于有强安全管控要求的企业,敏感作品需要经过企业内部的审计、权限体系进行监管认证后,才能进一步操作。

Quick BI中,可以灵活地在一些默认事件前,插入一段自定义的JavaScript代码,供您或您的组织实现定制化需求。

在开始之前,推荐先学习ES2015。官方指南假设你已了解关于HTML、CSS、JavaScript的中级知识。如果你刚开始学习前端,进行前端行为事件的开发可能不是很好的主意。

行为事件目前只支持在线开发模式,在该模式下,行为事件的开发和调试将在页面中进行,无需安装开发环境,更容易上手。在开始之前,您需要使用组织管理员账号登录Quick BI。

行为事件的设计逻辑是在开放平台内行为事件内进行事件的集中管控(仅组织管理员能够进行访问管控),具体包括事件的注册、调试、发布、变更等内容。在具体的报表内进行事件的配置(报表管理员即可进行访问配置)。

注册事件

首先需要主要一个行为事件。

  1. 您可以按照图示方式进入新建行为事件页面。

    image

  2. 在注册事件界面,进行以下配置。

    image

    配置项

    说明

    事件名称

    您可以自定义行为事件的名称。

    事件类型

    事件触发的时间点,目前支持作品导出前、作品查看前和作品发布前。

    适用范围

    添加事件的应用范围。

    • 作品导出前和作品发布前支持仪表板、电子表格、即席分析和自助取数。

    • 作品查看前支持仪表板和电子表格。

    是否全局生效

    事件默认的生效范围,选择全局生效将会对适用范围内的所有作品配置上该事件。

    平台

    添加事件的平台,目前仅支持PC端。

    开发模式

    目前只支持在线编辑模式,在页面中编辑调试。

    开启ShadowDOM

    开启ShadowDOM,可以将标签、样式和行为里隐藏起来,实现样式隔离。

    执行顺序

    同一时间点配置多个事件时,事件执行的顺序。

    依赖的第三方库

    可选项,填写CDN地址,用于提升组件性能。

    备注

    给自定义组件添加备注。

  3. 单击确定后完成行为事件的创建。

调试事件

注册好事件后,点击对应事件项的调试组件图标进行调试。

  1. 您可以在行为事件页面,单击image..png图标,按照图示步骤前往调试。

    3.png

  2. 单击前往调试后,进入调试界面。

    在打开的作品编辑页面中,会唤起一个在线的代码编辑器,您可以进行自定义事件的开发,具体编码方式请参见行为事件API

    在编码过程中,你可以在点击运行后,触发相应的事件来验证代码。

    4.png

    说明

    需要注意的是,当作品处于调试事件界面时,其页面设置中的行为事件仅仅会展示当前事件,勾选与否取决于该事件是否为全局事件,对于非全局事件,需要通过手动勾选该事件进行触发。在调试事件时,点击保存作品,将会对配置事件生效。具体配置事件规则请参见配置事件

发布事件

如果您在调试页面对自己编写的行为事件感到满意,可以直接点击在线代码编辑器顶部的保存按钮后,再点击发布按钮发布事件。

5.png

也可以在代码编辑器点击保存事件后,在行为事件列表页进行事件的发布。

6.png

发布事件会唤起发布事件弹窗,可以进行配置变更的比对。

7.png

支持查看代码比对

8.png

事件发布后,在列表页的事件状态将会变更为已发布

管理事件

发布事件后,仍可以在集中管理列表页,对事件进行编辑、调试、删除等操作,修改事件后,事件状态将会变为待发布,此时线上运行的仍然是之前已发布的事件内容,修改后需要点击发布后才会真正生效。

在行为事件页面,您可以进行以下操作。

9.png

编辑

单击image..png图标进入修改事件界面,您可以修改事件名称、适用范围等,单击确定后保存修改。

10.png

各配置项的说明请参见配置项说明

调试

调试的操作请参见调试事件

禁用/启用

如果您想取消事件在全局的影响,同步保留事件配置、代码等内容,可以点击image..png图标,将事件的运行状态改为失效状态。失效状态的事件将不会在作品的事件配置页面出现,如果想要出现,再次点击image..png图标激活事件。

发布

单击image..png图标发布行为事件。请参见发布事件

删除

单击image..png图标删除对应行为事件。

如果您想取消事件在全局的影响,同步保留事件配置、代码等内容,可以点击小眼睛图标,将事件的运行状态改为失效状态。失效状态的事件将不会在作品的事件配置页面出现,如果想要出现,再次点击小眼睛即可。

14.png

配置事件

如果您之前配置的是全局事件,那么所有的作品都将会默认配置上该事件;如果您配置的是非全局事件,那么所有的作品都不会配置上该事件。因此建议您针对大部分作品都要生效的作品配置全局事件,对大部分都不生效的作品配置非全局事件。

此外,您也可以手动针对报表配置事件(需要有对应报表的编辑权限)。您可以进入对应的作品,在页面设置 > 行为事件中唤起行为事件配置弹窗,此处采用复选框的方式支持对事件的自由配置。在事件配置弹窗内,组织管理员还可以点击事件右侧的图标笔,唤起在线代码编辑器,对事件进行编辑修改。

11.png

至此,您已经完成了行为事件的注册、调试、发布、管理、配置一整个流程,您所配置的事件将会在对应的时机进行触发。