1概述
Smartbi不断总结客户在定制个性化报表时的需求,在产品代码内部封装了一部分常用的对象,提供接口供具有一定前端经验的用户,针对报表进行二次开发,本文主要介绍报表宏接口(API接口:客户端报表宏接口文档),接口文档包含常用对象的具体方法及属性。
客户端报表宏是指事件在客户端进行处理。在Smartbi中,为不同类型的报表【电子表格】、【透视分析】、【即席查询】等提供了客户端处理的事件,客户端宏的语法就是JavaScript,Smartbi不断总结客户在定制个性化报表时的需求,在产品代码内部封装了一部分常用的对象,提供接口供具有一定前端经验的用户,针对报表进行二次开发,本文主要介绍报表宏接口。在客户端进行处理。在Smartbi中,为不同类型的报表【电子表格】、【透视分析】、【即席查询】等提供了客户端处理的事件,客户端宏的语法就是JavaScript。
注意:客户端宏主要影响浏览器端的展现效果,除了图形(直接加在图形对象上的部分宏功能可以对导出生效),其他报表的客户端宏都不会对导出有效果。
所有模块的宏示例请见报表宏示例库,下面逐一介绍不同报表类型组件接口。
2报表宏接口说明
按照Smartbi报表类型,客户端报表宏分为6973181369731817,6973181369731817,69731813,其中,除了各报表类型特有的对象外,event 69731817等,其中,除了各报表类型特有的对象外,event 和 chartView 为报表类型共有对象,并且对象成员出现有前置条件,具体介绍如下:
...
对象及其成员名 | 解释 | 前置条件 | 示例 | ||||
---|---|---|---|---|---|---|---|
application | 宏执行环境的顶层对象 | —————— |
| ||||
chart | 图形渲染对象 | —————— | |||||
chartView | 客户端图形浏览对象 | 新建模块时,对象选择chart,并且报表中含有ECharts图形。 | |||||
event | 当前的事件对象 | —————— |
| ||||
point | ECharts图形点击对象 | 新建模块时,对象选择Chart,事件选择pointClick,并且报表中含有ECharts图形。 |
| ||||
param | 参数对象 | 新建模块时,选择任意对象,事件选择onParamValueChanged,并且报表中含有参数。 |
API接口:入口
以下接口关系图展现的包含关系,表示被包含的对象为包含的对象的成员变量。例如chartView包含chart,表示chart为chartView的成员变量。
...
电子表格报表宏中,各对象之间的包含关系如下图:
电子表格报表宏中,除去6973181369731817以外,还有如下表的对象及成员,部分成员有前置条件,详细介绍如下表:
...
即席查询报表宏中,各对象之间的包含关系如下图:
即席查询报表宏中,除去6973181369731817以外,还有如下表的对象及成员,详细介绍如下表:
对象及其成员名 | 解释 | 示例 |
---|---|---|
simpleReport | 即席查询对象 | |
simpleReportContext | 即席查询的上下文对象 | |
simpleReportGrid | 即席查询的表格对象 |
...
透视分析报表宏中,各对象之间的包含关系如下图:
透视分析报表宏中,除去6973181369731817以外,还有如下表的对象及成员,详细介绍如下表:
对象名 | 解释 | 示例 |
---|---|---|
insight | 透视分析对象 |
...