历史版本30 :工具栏接口 返回文档
编辑时间: 内容长度:图片数:目录数: 修改原因:

目录:

版本编辑

版本功能变动
11.0

和 10.0 区别：

  • 获取按钮接口参数有变化，11.0 使用按钮名称

  • 新增 toolBarFloat 、setStyle 接口

  • 新增 getToolbar 接口

注1：工具栏所有接口在普通报表中使用时，要求报表中只有一个工具栏，即顶部工具栏或底部工具栏只存在一个。

注2：以下接口不支持在 FVS 可视化看板中使用。

在使用接口前，请务必先仔细阅读 JS API 兼容说明，接口默认支持普通报表和决策报表（新版）。

getWidgetByName编辑

方法getWidgetByName(name)获取报表工具栏中的按钮，可结合按钮的方法使用
     参数name: string

按钮名称，字符串，以下为常用按钮的名称

  • submit：提交按钮

  • verify：数据检验

  • first：首页

  • previous：上一页

  • next：下一页

  •  last：末页

  • flashprint：打印（客户端）

  • email：邮件

  • PDF：pdf

  • pagenavi ：当前页/总页数

  • stashbutton：暂存

  • clear：清空

   返回值按钮对象
object
     示例

示例1：若获取到的工具栏对象定义为 toolbar ，获取工具栏中的邮件按钮

toolbar.getWidgetByName("email");

示例2：普通报表中获取工具栏中邮件按钮

_g().getToolbar().getWidgetByName("email");


  应用示例

填报成功后，工具栏隐藏「邮件」和「打印」按钮：

点击可下载模板：工具栏按钮不可见.cpt

2021-09-01_14-01-01.gif

   移动端不支持移动端

getToolbar编辑

在普通报表中使用时，要求报表中只有一个工具栏，即顶部工具栏或底部工具栏只存在一个

普通报表中的使用方法getToolbar()获取工具栏对象
参数-

-

返回值按钮对象
object
示例

示例1：获取到报表对象定义为 report，获取工具栏对象

report.getToolbar();

示例2：普通报表中获取工具栏对象

_g().getToolbar();


  应用示例

-

   移动端支持移动端

决策报表中的使用方法

决策报表中的使用方法getToolbar(index)获取报表块的工具栏，在工具栏打开的情况下使用，获取后使用工具栏接口和工具栏按钮接口
     参数

index: number


工具栏位置，数字

  • 0：顶部工具栏

  • 1：底部工具栏

   返回值工具栏对象object
     示例

示例1：获取到报表块对象定义为 report，获取顶部工具栏对象

report.getToolbar(0);

示例2：决策报表中获取 report0 报表块的顶部工具栏对象

_g().getWidgetByName("report0").getToolbar(0);

示例3：决策报表中获取 report0 报表块的顶部具栏，并将其隐藏

_g().getWidgetByName("report0").getToolbar(0).setVisible(false);


  应用示例

点击按钮隐藏决策报表报表块的工具栏：

点击可下载模板：点击按钮隐藏报表块工具栏.frm626-1707.gif

   移动端支持移动端

toolBarFloat编辑

方法toolBarFloat(direction)设置工具栏显示位置
     参数direction: string

显示方式，字符串

  • left：居左显示

  • right：居右显示

  • center：居中显示

   返回值void
     示例

示例1：若获取到的工具栏对象定义为 toolbar ，设置工具栏居中显示

toolbar.toolBarFloat('center');

示例2：普通报表中设置工具栏居中显示

_g().getToolbar().toolBarFloat('center');

示例3：决策报表中设置工具栏居中显示

_g().getWidgetByName('report0').getToolbar(0).toolBarFloat('center');


  应用示例

普通报表中设置工具栏居中显示：

点击可下载模板：工具栏居中显示.cpt

   移动端不支持移动端

setStyle编辑

方法setStyle(style)修改工具栏大小
     参数style:

{

    width: number，

    height: number

}

工具栏大小，json 格式

  • width: 工具栏长度

  • height: 工具栏高度

   返回值void
     示例

示例1：若获取到的工具栏对象定义为 toolbar ，修改工具栏大小为长 900，高 60

toolbar.setStyle({    width: 900,    height: 60});

示例2：普通报表中修改工具栏大小为长 900，高 60

_g().getToolbar().setStyle({    width: 900,    height: 60});

示例3：普通报表中修改工具栏大小为长 900，高 60

_g().getWidgetByName('report0').getToolbar(0).setStyle({    width: 900,    height: 60});


  应用示例

普通报表中设置工具栏长 900，高 60：

点击可下载模板：修改工具栏大小.cpt

   移动端不支持移动端

setVisible编辑

方法setVisible(visbility)设置工具栏显示/隐藏
     参数

visbility: boolean

工具栏是否显示，布尔型

  • true: 工具栏显示

  • false: 工具栏隐藏

   返回值void
     示例

示例1：若获取到的工具栏对象定义为 toolbar ，隐藏工具栏

toolbar.setVisible(false);

示例2：普通报表中隐藏报表的工具栏

_g().getToolbar().setVisible(false);

示例3：决策报表中隐藏报表的工具栏

_g().getWidgetByName('report0').getToolbar(0).setVisible(false);


  应用示例

普通报表中设置隐藏报表的工具栏：

点击可下载模板：隐藏工具栏.cpt

   移动端支持移动端