查看源

1.功能简介

报表宏是 Smartbi 里面的一项特殊功能，顾名思义，就是基于报表的扩展，目的是为了让用户对报表进行自定义的改造，实现特定的功能。

报表宏是 JavaScript 的代码集合体，我们也称之为“宏模块”。通过报表资源抛出的事件（如报表加载事件、报表刷新事件、参数改变事件、点击事件等）对宏脚本触发执行。如下图，对透视分析实现了限制开始日期与结束日期之间不超过一年，超过则进行提示。

Smartbi Insight V10帮助中心 > 报表宏 > 01.png

2.学习指南

1、请先查看报表宏简介，了解报表宏是什么，报表宏需要的技术基础，以及如何创建。

2、接下来学习“跳转规则”，了解如何按照系统的提示流程，在各环节中以界面配置的方式实现资源间的互动效果。

3、接下来学习“客户端宏”，了解客户端宏的原理、包含的事件、对象，以及API。

4、接下来学习“服务端宏”，了解服务端宏的原理、包含的事件、对象，以及如何开发并调试。

5、最后学习“报表宏的调试”，了解报表宏的一些调试技巧。

6、宏示例库，这是在实际项目应用中提炼出来的常见需求场景。

术语	定义
宏代码库	工具宏用来定义一些公共的宏方法，将一些使用频率较高的方法定义为公共的方法，以便更好的重用，消除重复。各个报表资源的宏、宏资源包都可以使用use语法引用这里的方法。
宏资源包	资源包是具有相同特征的一类资源的集合。如来自相同数据源的多个报表资源或多个页面资源的集合。主要用于对多张报表或页面共享同一个宏。
宏控制台	查看服务端宏代码的后台日志输出。
服务端模块	表示宏的事件由服务端触发，模块里面的宏代码由服务端进行处理，例如电子表格根据参数值隐藏行列-服务端宏。
客户端模块	表示宏的事件由浏览器端触发，模块里面的宏代码由浏览器端进行处理，例如电子表格工具栏上添加按钮。
宏模块	指的是宏脚本，即 JavaScript 代码集合。
跳转规则	跳转规则属于一类特殊的报表宏，是指专门实现报表之间关联跳转功能的报表宏，例如：分析流、报表下钻等分析。

您可以使用下表快速访问 Smartbi 报表宏开发指南的各个部分。