1、功能简介
报表宏是 Smartbi 里面的一项特殊功能,顾名思义,就是基于报表或页面资源的扩展,目的是为了让用户对报表进行自定义的改造。报表宏是 JavaScript 的代码集合体,我们也称之为宏模块。通过报表资源抛出的事件(如报表加载事件、报表刷新事件、参数改变事件、点击事件等)对宏脚本触发执行。
文档目录:
2、使用场景
报表宏用于对系统中,部分灵活分析报表、组合分析、透视分析、电子表格、多维分析报表和页面等报表或页面资源的改造。事实上只要撑握了报表宏的开发(见报表宏快速入门),完全可以让上述提到的报表资源按自己的意愿显示。如:
- 隐藏报表上的一些功能键,例如电子表格隐藏工具栏按钮;
- 在报表的表头/表尾处添加分析报告,例如表头表尾增加图片;
- 实现报表与报表之间的相互跳转,例如联动跳转;
- 根据参数的改变,显示不同的字段或图形,例如列名随参数变化而变化;
- 报表或页面增加额外的功能等等。
注意:如果所有同类报表都需要实现某个功能,除了考虑资源包,也可以考虑使用扩展包实现,譬如所有灵活分析都添加一个“指标解释”就可以考虑使用扩展包。
3、报表宏的特点
报表宏具有以下特点:
- 报表宏以资源(报表资源、页面资源、资源包)为应用载体,类似于 Excel 宏是以 Excel 文件为载体;
- 报表宏使用 JavaScript 语言开发;
- 报表宏是按照事件进行触发(如报表加载事件、报表刷新事件、参数改变事件、点击事件等);
- 在同一载体里面的报表宏可以相互引用。
4、术语及定义
术语 | 定义 |
---|---|
工具宏用来定义一些公共的宏方法,将一些使用频率较高的方法定义为公共的方法,以便更好的重用,消除重复。各个报表资源的宏、宏资源包都可以使用use语法引用这里的方法。 | |
资源包是具有相同特征的一类资源的集合。如来自相同数据源的多个报表资源或多个页面资源的集合。主要用于对多张报表或页面共享同一个宏。 | |
宏控制台 | 查看服务端宏代码的后台日志输出。 |
服务端模块 | 表示宏的事件由服务端触发,模块里面的宏代码由服务端进行处理,例如电子表格根据参数值隐藏行列-服务端宏。 |
客户端模块 | 表示宏的事件由浏览器端触发,模块里面的宏代码由浏览器端进行处理,例如电子表格工具栏上添加按钮。 |
宏模块 | 指的是宏脚本,即 JavaScript 代码集合。 |
跳转规则属于一类特殊的报表宏,是指专门实现报表之间关联跳转功能的报表宏,例如:分析流、报表下钻等分析。 |