Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • uiType
    说明:设置HTML5 Viewer的界面模式。
    类型:字符串可接受值:'Custom', 'Mobile' 或者 'Desktop'
    示例:
    viewer.option('uiType', 'Mobile');

  • element
    说明:JQuery选择器,指定承载HTML5 Viewer控件的元素。
    注意:此选项仅在初始化期间使用。
    类型:字符串
    示例:
    var viewer = GrapeCity.ActiveReports.Viewer({element: '#viewerContainer2', reportService: {url: '/ActiveReports.ReportService.asmx'},});

  • reportService
    说明:可以使用葡萄城报表服务。
    类型:具有url和可选securityToken属性的对象
    示例:
    reportService: {url: 'http://remote-ar-server.com/api', securityToken: '42A9CD80A4F3445A9BB60A221D042FCC', resourceHandler: ' http://remote-ar-server.com/cache'};

  • reportService.url
    说明:提供报表相关信息和输出的葡萄城报表服务的URL。
    类型:字符串
    示例:
    reportService: { url: 'http://remote-ar-server.com/api' };

  • reportService.securityToken
    说明:登录葡萄城报表服务器所需的安全密钥。
    类型:字符串
    示例:
    reportService: { securityToken: '42A9CD80A4F3445A9BB60A221D042FCC'};

  • reportService.resourceHandler
    说明:葡萄城报表服务器资源处理程序的URL。
    类型:字符串
    示例: reportService: { resourceHandler: ' http://remote-ar-server.com/cache'};

  • report 
    说明:显示在葡萄城报表服务器中的报表。
    类型:具有id和参数属性的对象。
    示例:
    report: {
    id: 'CustomersList',
    parameters: [
    {
    name: 'CustomerID',
    value: 'ALFKI'
    }
    ]
    };

  • reportID 
    说明:要由HTML5查看器显示的报表的ID。
    类型:字符串
    示例:
    report: {
    id: 'CustomersList',
    parameters: [
    {
    name: 'CustomerID',
    value: 'ALFKI'
    }]
    };


  • reportParameters 
    说明:描述用于运行报表的参数值的{name,value}对的数组。
    类型:数组
    示例: report: {
    id: 'CustomersList',
    parameters: [
    {
    name: 'CustomerID',
    value: 'ALFKI'
    },
    {
    name: 'productIDs',
    value: [10248, 10249],
    multivalue: true
    }]
    };


  • reportLoaded
    说明:当HTML5查看器获取有关请求的报表的信息时调用的回调。
    reportInfo对象在回调中传递,包括目录信息,参数信息以及指向呈现的报表结果的链接。
    类型:function(reportInfo)
    示例:
    var reportLoaded = function reportLoaded(reportInfo){ console.log(reportInfo.parameters); };
    viewer.option('reportLoaded', reportLoaded);

  • action
    说明:在HTML5查看器之前调用的回调打开超链接,书签链接,向下钻取报表或切换报表控件的可见性。
    类型:function(actionType, actionParams)
    示例:
    function onAction(actionType, actionParams){
      if (actionType === 0){ window.open(params.url, "Linked from report", "height=200,width=200"); }
    }
    viewer.option('action', onAction);

  • availableExports 
    说明:通过HTML5查看器的导出功能可用的导出类型数组。 默认情况下,PDF,Word,图像,Mht和Excel导出可用。
    类型:数组
    示例:
    viewer.option("availableExports", ['Pdf']);


  • maxSearchResults
    说明:单次查找收到的查找结果数量调用。
    类型:数字
    示例:
    maxSearchResults:10

  • error
    说明:在显示报表的过程中发生错误时调用的回调。 如果回调返回true,则不显示默认错误面板。 错误参数是一个具有消息属性的对象,允许用户自定义错误消息。
    类型:function(error)
    示例:隐藏默认错误面板
    var options = {
      error: function(error){
        if (error.message) {
          // show error message.
          alert("Internal error! Please ask administrator.");
          return true; // do not show default error message.
        }
      },
      // other properties.
    };
    var viewer = GrapeCity.ActiveReports.Viewer(options);
    示例:自定义错误消息
    var options = {
      error: function(error){ error.message = "My error message"; },
      // other properties
    };
    var viewer = GrapeCity.ActiveReports.Viewer(options);

  • documentLoaded
    说明:当文档完全加载到服务器时调用的回调。
    类型:function()
    示例:
    var documentLoaded = function documentLoaded(){ setPaginator(); }; 
    viewer.option('documentLoaded', documentLoaded);

  • localeUri
    说明:包含本地化字符串的文件的URL。
    注意:此选项仅在初始化期间使用。
    类型:字符串
    示例:
    var viewer = GrapeCity.ActiveReports.Viewer({ localeUri: 'Scripts/i18n/ru.txt' });

  • showOnlyLastError
    说明:删除错误面板中的显示详细信息按钮,仅显示最后一个错误。
    类型:字符串示例:隐藏"显示详细信息"按钮
    var viewer = GrapeCity.ActiveReports.Viewer({ showOnlyLastError: true });


(2)公共的方法和属性

初始化HTML5 Viewer后,可以使用以下API方法和属性。
方法

...