`

Web报表工具FineReport的JS API开发(一)

阅读更多

很多报表软件可以利用JS接口来实现更多更复杂的功能。以FineReport为例,开放了大量的JS API给用户,根据执行JS的主体不同可以将分为三大类:FRFScontentWindow

js语句中执行可以使用FR的方法或者属性,比如说FR.Msg.alertFR中的方法比如引入finereport.jsFS的方法可以用于数据决策系统中的js接口,比如说FS.tabPane.addItem。而contentWindow是在web页面集成的时候,将F报表嵌入在iframe中,调用报表对象时使用的接口,比如说:document.getElementById('reportFrame').contentWindow,其中document.getElementById('reportFrame')是获取iframe对象,contentWindow是报表对象,相当于html中的window对象。

由于篇幅,这里先介绍FR

FR

 

大家知道,预览报表时,报表servlet会将cpt模板转为html,在这个htmlhead头部中会引入FRjs,如下:

<script type="text/javascript" src="/WebReport/ReportServer?op=emb&resource=finereport.js"></script>

这个finereport.js中包含了许多内置的function以及一些公有的属性,不管在模板中还是其他网页中,只要引入了finereport.js,就能够通过FR.xxx的形式调用公有的属性与方法

 

比如,在模板中使用,访问模板时会自动引入finereport.js,因此在模板的js脚本中可以直接使用FR.xxx来调用方法,如下图:


或者需要在自己的网页如某个jsp页面中调用FR的方法,要先引入finereport.js,再通过FR.xxx来调用,如下:

<html>
 <head>
  <script type="text/javascript" src="/WebReport/ReportServer?op=emb&resource=finereport.js"></script>
  <script type="text/javascript">
	var url = FR.cjkEncode("/WebReport/ReportServer?reportlet=Gettingstarted.cpt&地区=华东");
	window.open(url);
  </script>
 </head>
 <body> 
 </body>
</html>

对于常用的FR方法,这里列了一张表

方法

返回值

说明

ajax

void

ajax请求

cjkDecode(cjkEncode String)

String

cjkEncode过的字符串进行反编码

cjkEncode(String)

String

对字符串进行cjkEncode编码

closeDialog()

void

关闭对话框

doHyperlinkByGet(url,config,target,feature)

void

超级链接,get传递config参数到target中,并在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打印

$.isArray(object)

Boolean

是否为数组,是返回true,否返回false

isEmpty(object)

Boolean

是否为空,是返回true,否返回false

jsonDecode(jsonEncode String)

String

jsonEncode过的字符串进行反编码

jsonEncode(String)

String

对字符串进行jsonEncode编码

showDialog(title, width, height, innerContent)

void

显示一个对话框

这里主要细讲一下MsgAjax方法。

1  FR.Msg

FR内置了统一风格的消息框,替代实现了window中的alertconfirm以及prompt

1.1  FR.Msg.alert方法

使用方法

FR.Msg.alert(title, message, callback),弹出警告框。

title:对话框标题;message:对话框里显示的提示详细;callback:点击确定时调用的方法。

注意,callback是一个function方法,所以在写callback的时候必须为一个方法。

 

如在某个控件增加编辑结束事件,JS为:FR.Msg.alert("警告","值错误");,在该控件编辑结束后,会看到如下图所示的对话框:



1.2  FR.Msg.confirm方法

使用方法

FR.Msg.confirm(title, message, callback, min_width),弹出带有确认和取消按钮的对话框。

title:对话框标题;message:对话框里显示的提示详细;cellback:点击确定时调用的方法;min_width:表示最小宽度。

 

如在某个删除按钮中增加点击事件,JS为:FR.Msg.confirm("警告","确认要删除吗?");,点击删除行时会看到,会看到如下图所示的对话框:



注意,此方法无法获取点击“确定”或“取消”的返回值,此方法主要是触发回调函数的。若希望通过返回值的不同来进行下面的操作,则可使用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.Msg.toast方法

使用方法

FR.Msg.toast(message),报表从页面右上角弹出来的那个长条形信息。

message:弹出的信息

 

如给某个模板增加填报成功事件,JS为:FR.Msg.toast("填报成功");,在点击提交按钮,提交成功后会看到页面的右上角弹出如下对话框:



2  FR.ajax

大家知道JS是前端代码,直接由浏览器来执行,不会与服务器进行交互。

通过AJAX,用户就可以使用JavaScriptXMLHttpRequest对象来直接与服务器进行通信。且在不重载页面的情况下与Web服务器交换数据,也就是所谓的异步请求。

2.1 调用语法

 

如下ajax示例:

FR.ajax({
   url: "some.jsp",
   type: "GET",
   data: "p1=a&p2=b",
   success: function(msg){
     alert( "Data Saved: " + msg );
   }
});

2.2  ajax中的选项说明

上例中的urltypedata等都是ajax请求设置时的选项,这些选项都是可选的,以下列出常用选项并说明。

asyncBoolean

默认为true,所有请求均为异步请求。如果需要发送同步请求,请将此选项设置为 false

注:同步请求将锁住浏览器,用户其它操作必须等待请求完成才可以执行。

completeFunction

 

请求完成后回调函数(请求成功或失败之后均调用)。如下:

FR.ajax({
   url: "some.jsp",
   complete: function(XMLHttpRequest, textStatus){
     alert(this.url);
   }
});

其中参数为XMLHttpRequest 对象和一个描述成功请求是否成功的字符串(成功textStatus=success,否则为error)

function中可以通过this.xxx来调用该ajax请求中的选项值。

dataObject/String

发送到服务器的数据。GET请求中将自动转换为请求字符串格式,附加在url后。

值必须是Key/Value格式,可以是字符串如"p1=pavalue&p2=p2value",或者是对象如{p1:p1value,p2:p2value}

dataTypeString

预期服务器返回的数据类型。如果不指定,将自动根据HTTPMIME信息来智能判断。可用值有:

"xml":返回 XML 文档

"html":返回纯文本HTML信息;包含的script标签会在插入dom时执行。

"script":返回纯文本JavaScript代码。

"json":返回JSON数据。

"text"返回纯文本字符串。

errorFunction

 

请求失败时调用此函数。如下:

FR.ajax({
   url: "some.jsp",
   error: function(XMLHttpRequest, textStatus, errorThrown){
     alert(this.url);
   }
});

 其中参数为XMLHttpRequest 对象、错误信息、捕获的异常对象。

 

通常textStatuserrorThrown之中只有一个会包含信息。

 

successFunction

 

请求成功后的回调函数,如下:

FR.ajax({
   url: "/WebReport/a.html",
   success: function(data, textStatus){
     alert(this.url);
   }
});

 其中data为服务器返回的,并根据dataType参数进行处理后的数据。textStatus为状态值sucess

 

timeoutNumber

 

设置请求超时时间(毫秒)。此设置将覆盖全局设置。

 

ypeString

 

请求方式POSTGET,默认为GET

 

urlString

 

发送请求的地址。

 

 

关于FScontentWindow,会在下一节介绍。

  • 大小: 3.8 KB
  • 大小: 1.3 KB
  • 大小: 1.6 KB
  • 大小: 886 Bytes
  • 大小: 468 Bytes
分享到:
评论

相关推荐

    Web报表工具FineReport的JS开发之字符串

    在报表开发过程中,有些需求可能无法通过现有的功能来实现,需要开发人员二次开发,以FineReport为例,可以使用网页脚本、API接口等进行深入的开发与控制。 考虑到JS脚本开发的使用较多,这里先先简单介绍如何用JS对...

    移动端报表FineReport的JS开发示例

    FineReport是一个专业的报表工具,特别是在移动端报表开发中表现出色。本文针对FineReport在移动端的JavaScript(JS)二次开发给出了一些示例和说明。以下详细知识点涵盖了移动端报表开发中如何利用FineReport的JS...

    web,spring boot 集成帆软,finereport

    在本文中,我们将深入探讨如何将Web应用与Spring Boot框架集成帆软报表工具Finereport。Spring Boot以其简洁、高效和自动配置的特性,成为Java领域开发微服务和Web应用的首选框架。而Finereport作为一款强大的报表...

    finereport跨域打印文档

    【Finereport跨域打印文档】是指在使用帆软报表工具Finereport时,涉及到的在不同源(即跨域)环境下进行文档打印的技术说明。跨域打印是Web开发中的一个重要概念,通常涉及到浏览器的同源策略限制。由于安全原因,...

    Angular 中使用 FineReport不显示报表直接打印预览

    在开发Web应用时,有时我们需要集成报表功能,FineReport是一款常用的报表工具,它提供了与多种前端框架集成的能力,包括Angular。然而,在某些情况下,我们可能希望用户能够直接打印报表而无需先显示报表内容,这就...

    JS实现点击参数面板按钮显示或隐藏数据

    在网页交互设计中,有时需要根据用户操作动态地显示或隐藏特定的...此方法同样适用于其他支持JavaScript交互的报表工具,只需适配相应的API和元素选择器。了解这些基础知识对于构建交互式、用户友好的Web报表至关重要。

    帆软fcra帮助树形文档.docx

    【帆软FCRA帮助树形文档】主要涵盖了帆软报表工具FineReport的多个核心知识点,以下将对这些关键内容进行详细解析: 1. **升级兼容说明**:在更新到10.0版本时,需要了解关于软件升级的兼容性问题,确保现有的功能...

    帆软fcra帮助树形文档.pdf

    是针对帆软报表工具——FineReport的详细使用手册,涵盖多个方面,包括快速入门、设计思路、报表设计、参数应用、图表、填报、操作指南、授权注册、报表美化、移动端、大屏数据可视化、数据连接、性能优化、二次开发...

    JS调用某段SQL语句的方法

    对于特定的报表工具,如FineReport,它提供了内置的函数来简化这个过程。如文中所示,可以使用`FR.remoteEvaluate()`函数来执行SQL。例如: ```javascript var sql = "SQL(\"数据库连接名\",\"SELECT COUNT(*) FROM ...

Global site tag (gtag.js) - Google Analytics