1、文档目的
随着用户对 Smartbi 的深入使用,客户化报表定制要求将会越来越多。定制化需求不可能总是放到产品中开发,这时候就要优先考虑使用“报表宏”去实现。本文主要用于指导报表定制人员编写报表宏,通过对本文的学习,报表定制人员可以通过编写“报表宏”来实现客户方提出的一些报表定制化开发要求。
2、适用范围
面向 Smartbi 使用者,一般是报表定制开发人员。
3、学习指南
1)建议请先查看报表宏功能简介了解报表宏的基本概念、使用场景,这篇文章的快速入门是需要必看的一个示例,报表事件也是需要概览一下辅助理解宏是怎么回事。
2)上面说的报表宏功能简介中术语及定义也是需要认真看的,实际其对应报表宏开发教程
3)如果时间足够,宏示例是可以概览一遍加深理解,同时实际工作遇到也知道要到这里先找下类似示例
4)宏的开发实际离不开API,目前现阶段还没有完善的API文档,灵活开发需要了解每个宏对象对应的产品源码,新建一个跳转规则,单步调试进去就可看到,这里列出(有兴趣可以了解Smartbi前端框架介绍及调试定位入门,辅助理解下面这些对象,里面有些宏里面也可用到的调试技巧):
在eclipse中Ctrl+Shift+R输入文件名即可定位到对应文件。
宏对象 | js脚本 | 所在路径(smartbi.war下) |
simpleReport | QueryView.js | \vision\js\freequery\query |
simpleReportContext | QueryNavigator.js | \vision\js\freequery\query |
meterReport | Dashboard.js | \vision\js\bof\decisionpanel\dashboard |
olapQuery | OlapQueryViewDisplay.js 或 OlapQueryView.js | \vision\js\bof\olapquery\olapquery |
chart | 旧版图形:ChartView.js 以及父类 AbstractChartView.js 新版echarts图形:EChartsView.js以及父类 AbstractChartView.js | 旧版图形:\vision\js\smartbi\chart, 新版echarts图形:\vision\js\smartbi\echarts |
page | NewPage.js | \vision\js\bof\decisionpanel\newportal |
pageContext | 已废弃 | |
spreadsheetReport | SpreadsheetReport.js | \vision\js\smartbi\spreadsheetreport |
INSIGHT | Insight.js | \vision\js\smartbi\insight |
4、快速访问
使用下表快速访问报表宏开发指南,建议先从报表宏的功能简介开始。