《数据展示工具finereport的js api开发教程(一)》由会员分享，可在线阅读，更多相关《数据展示工具finereport的js api开发教程(一)（6页珍藏版）》请在金锄头文库上搜索。
1、数据展示工具数据展示工具 FineFineReportReport 的的 JS JS APIAPI 开发开发教程教程（一一） 很多报表软件可以利用 JS 接口来实现更多更复杂的功能。以 FineReport 为例，开放了大量的 JS API 给用户，根据执行 JS 的主体不同可以将分为三大类：FR、FS 和 contentWindow。 在 js 语句中执行可以使用 FR 的方法或者属性，比如说 FR.Msg.alert，FR 中的方法比如引入finereport.js。FS 的方法可以用于数据决策系统中的 js 接口，比如说 FS.tabPane.addItem。而contentWindow
2、 是在 web 页面集成的时候，将 F 报表嵌入在 iframe 中，调用报表对象时使用 的 接 口 ， 比 如 说 ： document.getElementById(reportFrame).contentWindow ， 其 中document.getElementById(reportFrame)是获取 iframe 对象，contentWindow 是报表对象，相当于 html 中的 window 对象。 由于篇幅，这里先介绍 FR FR 大家知道，预览报表时，报表 servlet 会将 cpt 模板转为 html，在这个 html 的 head 头部中会引入 FR 的 js，如下：
3、 这个 finereport.js 中包含了许多内置的 function 以及一些公有的属性，不管在模板中还是其他网页中，只要引入了 finereport.js，就能够通过 FR.xxx 的形式调用公有的属性与方法 比如，在模板中使用，访问模板时会自动引入 finereport.js，因此在模板的 js 脚本中可以直接使用 FR.xxx 来调用方法，如下图： 或者需要在自己的网页如某个 jsp 页面中调用 FR 的方法，要先引入 finereport.js，再通过FR.xxx 来调用，如下： var url = FR.cjkEncode(“/WebReport/ReportServer?rep
4、ortlet=Gettingstarted.cpt window.open(url); 对于常用的 FR 方法，这里列了一张表 方法 返回值 说明 ajax void ajax 请求 cjkDecode(cjkEncode String) String 对 cjkEncode 过的字符串进行反编码 cjkEncode(String) String 对字符串进行 cjkEncode 编码 closeDialog() void 关闭对话框 doHyperlinkByGet(url,config,target,feature) void 超级链接，get 传递 config 参数到 target 中
5、，并在 feature 里面设置窗口属性 doHyperlinkByPost(url,config,target,feature) void 超级链接，post 传递 config 参数，并将结果显示在 target 中,并在 feature 里面设置窗口属性 doURLAppletPrint(printurl,isPopUp,config) void applet 打印 doURLFlashPrint(printurl,isPopUp,config) void flasht 打印 doURLPDFPrint(printurl,isPopUp,config) void pdf 打印 $.isA
6、rray(object) Boolean 是否为数组，是返回 true，否返回 false isEmpty(object) Boolean 是否为空，是返回 true，否返回false jsonDecode(jsonEncode String) String 对 jsonEncode 过的字符串进行反编码 jsonEncode(String) String 对字符串进行 jsonEncode 编码 showDialog(title, width, height, innerContent) void 显示一个对话框 这里主要细讲一下 Msg 和 Ajax 方法。 1 FR.Msg FR 内置了
7、统一风格的消息框，替代实现了 window 中的 alert、confirm 以及 prompt。 1.1 FR.Msg.alert 方法方法 使用方法使用方法 FR.Msg.alert(title, message, callback)，弹出警告框。 title：对话框标题；message：对话框里显示的提示详细；callback：点击确定时调用的方法。 注意，callback 是一个 function 方法，所以在写 callback 的时候必须为一个方法。 如在某个控件增加编辑结束事件，JS 为：FR.Msg.alert(“警告“,“值错误“);，在该控件编辑结束后，会看到如下图所示的对
8、话框： 1.2 FR.Msg.confirm 方法方法 使用方法使用方法 FR.Msg.confirm(title, message, callback, min_width)，弹出带有确认和取消按钮的对话框。 title：对话框标题；message：对话框里显示的提示详细；cellback：点击确定时调用的方法；min_width：表示最小宽度。 如在某个删除按钮中增加点击事件，JS 为：FR.Msg.confirm(“警告“,“确认要删除吗?“);，点击删除行时会看到，会看到如下图所示的对话框： 注意，此方法无法获取点击“确定”或“取消”的返回值，此方法主要是触发回调函数的。若希望通过返回
9、值的不同来进行下面的操作，则可使用 window 中的 confirm 1.3 FR.Msg.prompt 方法方法 使用方法使用方法 FR.Msg.prompt(title, message, value, callback, min_width)，可以传递参数的对话框 title：对话框标题；message：对话框里显示的提示详细；callback：点击确定时调用的方法；Value：参数传递的默认值；min_width：表示最小宽度。 如在某个控件增加点击事件，JS 为：FR.Msg.prompt(“输入“,“爱好“,“运动“);，在该控件被点击时，会看到如下图所示的对话框： 1.4 FR
10、.Msg.toast 方法方法 使用方法使用方法 FR.Msg.toast(message)，报表从页面右上角弹出来的那个长条形信息。 message：弹出的信息 如给某个模板增加填报成功事件，JS 为：FR.Msg.toast(“填报成功“);，在点击提交按钮，提交成功后会看到页面的右上角弹出如下对话框： 2 FR.ajax 大家知道 JS 是前端代码，直接由浏览器来执行，不会与服务器进行交互。 通过 AJAX，用户就可以使用 JavaScript 的 XMLHttpRequest 对象来直接与服务器进行通信。且在不重载页面的情况下与 Web 服务器交换数据，也就是所谓的异步请求。 2.1
11、调用语法调用语法 如下 ajax 示例： FR.ajax( url: “some.jsp“, type: “GET“, data: “p1=a ); 2.2 ajax 中的选项说明中的选项说明 上例中的 url、type、data 等都是 ajax 请求设置时的选项，这些选项都是可选的，以下列出常用选项并说明。 async：Boolean 默认为 true，所有请求均为异步请求。如果需要发送同步请求，请将此选项设置为 false。 注：同步请求将锁住浏览器，用户其它操作必须等待请求完成才可以执行。 complete：Function 请求完成后回调函数(请求成功或失败之后均调用)。如下： FR
12、.ajax( url: “some.jsp“, complete: function(XMLHttpRequest, textStatus) alert(this.url); ); 其中参数为 XMLHttpRequest 对象和一个描述成功请求是否成功的字符串(成功textStatus=success，否则为 error)。 在 function 中可以通过 this.xxx 来调用该 ajax 请求中的选项值。 data：Object/String 发送到服务器的数据。GET 请求中将自动转换为请求字符串格式，附加在 url 后。 值必须是 Key/Value 格式，可以是字符串如“p1=
13、pavalue ); 其中参数为 XMLHttpRequest 对象、错误信息、捕获的异常对象。 通常 textStatus 和 errorThrown 之中只有一个会包含信息。 success：Function 请求成功后的回调函数，如下： FR.ajax( url: “/WebReport/a.html“, success: function(data, textStatus) alert(this.url); ); 其中 data 为服务器返回的，并根据 dataType 参数进行处理后的数据。textStatus 为状态值sucess。 timeout：Number 设置请求超时时间（毫秒） 。此设置将覆盖全局设置。 type：String 请求方式 POSTGET，默认为 GET。 url：String 发送请求的地址。
