报表控件Activereports使用教程:你必须要了解的Viewer API
ActiveReports 是一款专注于 .NET 和 .NET Core 平台的报表控件。通过拖拽式报表设计器,可以快速地设计 Excel表格、Word文档、图表、数据过滤、数据钻取、精准套打等类型报表,全面满足 WinForm、ASP.NET、ASP.NET MVC、WPF 平台中各种报表的开发需要。同时,通过丰富的 API 可以灵活的实现报表创建、加载和运行时的个性化自定义需求。
点击下载ActiveReports最新试用版
初始化Viewer 的选项设置
以下方式是在初始化Viewer 中会被执行的
action
说明: JSViewer 实现报表导航,如钻取,跳转URL,跳转书签,折叠展开控件时所执行的回调函数。
类型: function(actionType, actionParams)回调函数
示例::
action: (actionType, actionParams) => console.log('Action type: ' + actionType + '; Action parameters: ' + actionParams)
availableExports
说明: 是用于设置所提供的导出文件的格式,在不设置该选项时候,JSViewer 默认是支持所有格式导出,PDF, Excel, Word, JSON, XML, CSV, 图像
类型: Array(数组)
示例:
availableExports: ['Xml', 'Pdf']
displayMode
说明: 设置Viewer 是单页显示还是连续一页加载
类型: String(字符串)
可识别的值: ‘single’, ‘continuous’
示例:
displayMode: 'Continuous'
documentLoaded
说明: 当报表文档从服务器中完全加载完成后执行的回调函数。
类型: function() 回调函数
示例:
documentLoaded: () => console.log('The document is loaded entirely on the server')
返回值: Void 空
element
说明 JQuery 选择器,用于绑定JSViewer 的宿主对象。
类型: String
示例::
element: '#viewerContainer'
error
说明 : 当加载报表发生错误时候,所执行的的错误提示回调函数。如果回调函数返回的是True默认的错误提示面板就不会出现了。错误参数是一个包含message属性的对象,开发人员可自定义错误提示信息。
类型: function(error) 回调函数
示例: 隐藏默认的错误面板
error: (error) => {if (error.message) {// show error message.alert("Internal error! Please ask administrator.");// do not show default error message.}}
reportID
说明: 指定JS Viewer 加载报表的标识(或路径)
类型: String
示例:
reportID: 'AnnualReport.rdlx'
reportLoaded
说明: JSViewer 获取关于请求报表时所执行的回调函数,该回调函数会包含 reportInfo 对象,包含报表名称目录信息,参数信息,以及渲染报表结果的链接。
类型: function(reportInfo)
Example:
reportLoaded: (reportInfo) => console.log('The report ' + reportInfo.name+ ' was successfully loaded!')
reportParameters
说明: {name, value} 键值对的数组,用于为报表传递对应的参数值。
类型: Array(数组)
示例:
reportParameters: [{ name: 'ReportParameter1', values: ['1']}]
reportService
说明: 连接 WebAPI 的设置
类型:.包含URL 及可选的securityToken 属性的对象
示例:
reportService: {url: 'http://example.com/api/reporting', securityToken: '42A9CD80A4F3445A9BB60A221D042FCC',};
可调用的API 方法及属性
方法:
backtoParent
说明: 常用于报表钻取,报表钻取到子报表时,使用该方法可以让Viewer 返回到主报表。
类型: backToParent()Void
示例:
viewer.backToParent()
返回值: Void
create
说明: 新建一个新的Viewer 实例,并在指定的 DOM 元素中加载它。
Syntax: create()Void
Parameters:
params
Example:
const viewer = GrapeCity.ActiveReports.JSViewer.create({element: '#root',reportID: 'AnnualReport.rdlx',availableExports: ['Xml', 'Pdf'],// other properties});
Return Value: Void
destroy
说明: 从当前元素中删除Viewer
Syntax: destroy()Void
Example:
viewer.destroy()
Return Value: Void
export
说明: 导出当前报表
Syntax: export(exportType,callback,saveAsDialog,settings)Void
Parameters:
exportType: 指定导出格式.
settings: RenderingExtensions所提供的导出设置
注意: 区域报表的导出设置在使用rendering extensions时候不可用,。页面报表和RDL 报表使用Export Filter 导出PDF时不可用。
示例:
viewer.export('Pdf', downloadReport, true, { Title: '1997 Annual Report' })
Return Value: Void
getTOC
说明: 获取报表目录 TOC.
Syntax: viewer.getToc()
Example:
console.log(viewer.getToc())
Return Value: any
goToPage
说明: 指定Viewer 展示特定页的报表
Syntax: goToPage(number, offset, callback)Void
Parameters:
number: The number of pages to go to.
Example:
viewer.goToPage(1)
Return Value: Void
openReport
说明: 加载指定的报表文件报表
Syntax: openReport(reportID: string, reportParameters?: Array): void
Parameters:
reportID: The id of the report.
Example:
viewer.openReport(‘Invoice.rdlx’)
Return Value: Void
说明: 打印当前展示的报表.
Syntax: print()Void
Example:
viewer.print()
Return Value: Void
Refresh
说明: 刷新报表预览页面
Syntax: option(name,[value])Object
Example:
viewer.refresh()
Return Value: Void
Version
说明: 获取当前JSViewer 的版本。
Syntax: viewer.version
Example:
console.log(viewer.version)
Return Value: string
renderMode
说明: 获取或设置JS Viewer 的渲染模式
Type: String
Accepted Value: ‘Galley’, ‘Paginated’
Example:
viewer.renderMode = 'Galley';
toolbar.addItem
说明: 为工具栏添加自定义按钮
Type: item: ToolbarItem
Example:
ToolbarItem = {key: string;iconCssClass?: string;icon?: Icon;text?: string;title?: string;checked?: boolean;enabled?: boolean;action?: (toolbarItem) => function;onUpdate?: (args: ChangedEventArgs, toolbarItem) => function;}Icon = FontIcon | SVGIcon;SVGIcon = {type: 'svg';content: any; //(string | JSX.element)size?: Size;rotate?: '90' | '180' | '270';};FontIcon = {type: 'font';iconCssClass: string;fontSize?: string;}var pdfExportButton = {key: '$pdfExportButtonKey',iconCssClass: 'mdi mdi-file-pdf',enabled: true,action: function(item) {console.log('Export to PDF function works here');},onUpdate: function(arg, item) {console.log('Something in viewer was updated, check/update button state here');}};//OR button with svg as iconvar icon = ``;var svgPdfExportButton = {key: '$pdfExportButtonKey',icon: {type: 'svg', content: icon},enabled: true,action: function(item) {console.log('Export to PDF function works here');},onUpdate: function(arg, item) {console.log('Something in viewer was updated, check/update button state here');}}viewer.toolbar.addItem(pdfExportButton);//orviewer.toolbar.addItem(svgPdfExportButton);
toolbar.updateItem
说明: 更新设置某一工具栏按钮的布局,功能或状态
Type: String: key, ToolbarItem item
Example:
var xlsxExportButton = {
key: '$xlsxExportButtonKey',iconCssClass: 'mdi mdi-file-pdf',enabled: true,action: function(item) { console.log('Export to XLSX function works here'); },onUpdate: function(arg, item) { console.log('Something in viewer was updated, check/update button state here'); }
};
viewer.toolbar.updateItem('$pdfExportButtonKey', xlsxExportButton); //from now button will behave as described in new properties
toolbar.removeItem
说明: 删除工具栏的自定义的按钮。如果要删除默认的工具栏按钮, 需要调用 updateLayout 函数
Type: String: key
Example:
viewer.toolbar.removeItem('$pdfExportButtonKey');
toggleSidebar
说明: 设置侧边栏可见或隐藏。如果不传递值,默认是隐藏。
Type: boolean
Example:
viewer.sidebar.toggle(true);;//will hide it viewer.toggleSidebar(false);//will show it
可用属性
currentPage
说明: 获取当前加载页码
Syntax: viewer.currentPage
Example:
console.log(viewer.currentPage())
Return Value: An integer representing currently displayed page number.
pageCount
说明: 获取当前报表的总页数
Syntax: viewer.pageCount
Example:
console.log(viewer.pageCount())
Return Value: An integer representing page count.
如果你对我们的产品感兴趣或者有任何疑问,欢迎咨询慧都在线客服>>
慧都高端UI界面开发
报表控件Activereports使用教程:你必须要了解的Viewer API相关推荐
- access字段属性设置下拉列表_可嵌入您系统的.NET 报表控件ActiveReports:带状列表组件...
葡萄城报表控件ActiveReports V14.0 全面支持 .NET Core平台.同时 ActiveReports的桌面报表设计器UI也全面增强,报表预览方式得以全面优化,报表设计能力得以大幅提 ...
- dev 报表设计器 怎么设置每页10行_可嵌入您系统的.NET 报表控件ActiveReports:带状列表组件...
葡萄城报表控件ActiveReports V14.0 全面支持 .NET Core平台.同时 ActiveReports的桌面报表设计器UI也全面增强,报表预览方式得以全面优化,报表设计能力得以大幅提 ...
- flexcell控件 许可证信息没有找到_报表控件 ActiveReports 全面迎来 .Net Core 时代
报表控件ActiveReports全面迎来 .Net Core 时代!一键创建 .Net Core MVC 项目 近期,葡萄城报表控件ActiveReports V14.0 正式发布,全面支持 .NE ...
- 报表控件ActiveReports帮助高校实现办公、财务管理数字化
国内某知名高校教务处 陈主任: "我们教务处有十分多的文件.文档需要归纳整理,包括整个学校的文件通知公告.一些教务资源.职工工作日志记录.职工考勤记录等,同时还涉及一部分财务信息,职工的工资 ...
- html中报表视图插件,报表控件ActiveReports中全新的WebViewer组件
近期,葡萄城报表控件ActiveReports V14.0 正式发布,全面支持 .NET Core平台.同时,在本次更新中 ActiveReports的桌面报表设计器UI得以全面增强,报表预览方式得以 ...
- .net报表控件ActiveReports教程:运行时修改数据(附源码)
ActiveReports 是一款专注于 .NET 和 .NET Core 平台的报表控件.通过拖拽式报表设计器,可以快速地设计 Excel表格.Word文档.图表.数据过滤.数据钻取.精准套打等类型 ...
- 报表控件ActiveReports快速入门指南 - 如何为报表创建、添加数据
ActiveReports是一款专注于 .NET 平台的报表控件,全面满足 HTML5 / WinForm / ASP.NET / ASP.NET MVC / WPF 等平台下报表设计和开发工作需求, ...
- .NET报表控件ActiveReports:中铁物资管理系统案例探究
ActiveReports 是一款专注于 .NET 和 .NET Core 平台的报表控件.通过拖拽式报表设计器,可以快速地设计 Excel表格.Word文档.图表.数据过滤.数据钻取.精准套打等类型 ...
- 报表控件ActiveReports设计器,让报表开发更简单
ActiveReports是一款专注于 .NET 和 .NET Core 平台的报表控件.通过拖拽式报表设计器,可以快速地设计 Excel表格.Word文档.图表.数据过滤.数据钻取.精准套打等类型报 ...
最新文章
- Unity 摄像机搭配陀螺仪的使用
- 2019第十二届“认证杯”数学建模(第二阶段)
- NameServer的总控逻辑
- F# 4.0于全平台发布
- nginx+php-fpm 的配置下,php的错误日志
- 土木工程真的这么可怕吗?
- matlab-JDBC操作MYSQL数据库中文乱码解决
- Mac电脑 hbuilderx 运行到小程序node-sass异常
- mysql实验三单表和多表查询_数据库实验三(单表查询)
- 数据看穿一生:前半生赚钱养娃,后半生赚钱买命
- 尚硅谷为什么免费开放资源_什么是开放游戏? 新资源
- java 反射机制 在structs2_Java面试题之Struts2
- 电源测试之输出动态响应(Output Dynamic Response Test)
- XX和OO(南阳oj1159)
- 常用的线性充电IC和开关充电IC的区别
- 《资管新规》深度解读
- 联想M490原装Win8系统改Win7系统的血泪史
- 视频教程-从入门到精通学全套AI 轻松掌握illustrator基础加实战技能视频课程-Illustrator
- 25岁以后还适合花钱学编程,当程序员吗?
- Hutool - 信息脱敏工具 - DesensitizedUtil
热门文章
- HTML+CSS网站开发兵书
- “四大名旦”如何唱红上海滩?(图)
- 烈火如歌-ROS入门使用
- 9,Palindrome Number
- Palindrome Number---9
- resharper java_最强悍的VS插件—reSharper
- 简述什么是蜜罐?如何分辨一个系统是不是蜜罐.
- 集成学习boosting算法:AdaboostGBDTXgboostLightGBMCatBoost
- nginx 80端口被 ‘welcome to nginx‘ 欢迎界面占用,无法使用
- 《逆袭进大厂》第十一弹之MySQL25问25答