全局接口-FR

和 10.0 区别：

新增 servletURL、serverURL、server、fineServletURL、SessionMgr.getSessionID() 接口

补充 FVS 模板相关接口说明

适用于安装了「FineVis数据可视化」插件 V1.8.0 及之后版本的用户

showDialog 新增 padding、titleStyle、backgroundStyle 三个参数字段，仅支持 FVS V2.0.0 及之后版本

• showDialog 新增 dialogType、line、coordinate 三个参数字段，仅支持 FVS V2.0.1 及之后版本

• 新增 getCoordinate 接口，配合 showDialog 使用
  

获取 servletURL，返回值为字符串，格式如：

/webroot/decision/view/report

普通报表、决策报表示例：

FR.servletURL;

FVS 模板示例：

duchamp.servletURL;

支持移动端，移动端返回格式和 PC 端有区别，如：  /webroot/decision

获取 serverURL，返回值为字符串，格式如：

http://localhost:8075

普通报表、决策报表示例：

FR.serverURL;

FVS 模板示例：

duchamp.serverURL;

获取 server，返回值为字符串，格式如：

http://localhost:8075/webroot

普通报表、决策报表示例：

FR.server;

FVS 模板示例：

duchamp.server;

获取 fineServletURL，返回值为字符串，格式如：

/webroot/decision

普通报表、决策报表示例：

FR.fineServletURL;

FVS 模板示例：

duchamp.fineServletURL;

获取 sessionId，返回值为字符串，如：

62a0f071-c2c6-4623-91c3-3d58c6265c19

普通报表、决策报表示例：

FR.SessionMgr.getSessionID();

FVS 模板示例：

duchamp.SessionMgr.getSessionID();

点击按钮，打印报表的 sessionId：

点击可下载模板：打印sessionId.cpt

FVS 模板：打印sessionId.fvs

title：string

width：number

height：number

innerContent：iframe

注：11.0.10 及以后版本参数支持 json 格式，如下：

{

title:string,

width:number,

height:number,

innerContent:iframe

}

title：对话框标题，字符串

width：对话框宽度

height：对话框高度

innerContent：对话框内容，iframe 标签，如果要打开工程下的报表，需先将报表定义为 iframe 标签

string

示例1：打开一个标题为“弹窗”，宽 600、高 400 内容为 “Hello World”的对话框

普通报表、决策报表示例：

FR.showDialog("弹窗",600,400,"Hello World");

示例2：打开一个标题为“销量弹窗”，宽 700，高 500 ，弹窗内容为内置模板 GettingStarted.cpt 的对话框

注：设计器中添加如下较长代码时，注意换行导致的代码格式问题，修改格式即可。

普通报表、决策报表示例：

// 创建对话框内的 iframe，iframe参数的命名及宽高等
var iframe = $("<iframe id='inp' name='inp' width='100%' height='100%' scrolling='no' frameborder='0'>");
// 给 iframe 添加 src 属性，指向需要展示的模板地址
iframe.attr("src", "/webroot/decision/view/report?viewlet=GettingStarted.cpt");
//弹出对话框
FR.showDialog("对话框",700,500, iframe);

点击按钮，打开一个标题为“销量弹窗”，宽 700，高 500 ，弹窗内容为内置模板 GettingStarted.cpt 的对话框：

详细内容介绍可参考：JS实现弹窗后数据回填

title:string

width:number

height:number

innerContent:iframe

padding: style

titleStyle:style

backgroundStyle: style

dialogType:string

line: style

coordinate: array

title：弹出框标题，字符串

width：弹出框宽度

• 可填写具体数值，数值单位为 px 。例如 width: 500

• 可使用百分比表示占浏览器窗口的比例，例如 width:"50%"
  

height：弹出框高度

• 可填写具体数值，数值单位为 px 。例如 height: 300

• 可使用百分比表示占浏览器窗口的比例，例如 height:"50%"

innerContent：弹出框内容，iframe 标签，如果要打开工程下的报表，需先将报表定义为 iframe 标签

padding：内边距设置，例如 padding: "10px"

titleStyle：标题样式设置

backgroundStyle：边框背景样式设置

注：titleStyle 和 backgroundStyle 较为灵活，css 能实现的写法这里均支持

dialogType：弹出框的形式，默认为居中显示

• dialogType:"center" 代表弹出框居中显示

• dialogType:"dynamic" 代表弹出框动态显示，带有引导线

line：引导线配置

• type 属性仅支持 color ，即引导线的颜色

  例如 line: { type: "color", value:{ color: "red" }},

coordinate：引导线开始的坐标，基于预览模式下的坐标系，坐标为相对屏幕的坐标。例如 coordinate: [200, 300]

注：coordinate 可结合 getCoordinate 获取组件坐标接口使用，可使得引导线总是在组件位置打开

string

示例1：打开一个标题为“销量弹窗”，宽 700、高 500 ，内边距为 15px，字体加粗，字号 24px，背景色是绿色，内容为 “Hello World”的弹出框

duchamp.showDialog({
  title: "销量弹窗",
  width: 700,
  height: 500,
  innerContent: "Hello World",
  padding: "15px",
  titleStyle: { fontSize: "24px", fontWeight: "bold" },
  backgroundStyle: { background:"green" },
  dialogType:"center",
});

示例2：打开一个标题为“销量弹窗”，宽 700，高 500 ，弹窗内容为内置模板 GettingStarted.cpt 且居中显示的弹出框

"use document";
const iframe = document.createElement("iframe");
iframe.width = "100%";
iframe.height = "100%";
iframe.scrolling = "no";
iframe.style="border: none";
iframe.src = "/webroot/decision/view/report?viewlet=GettingStarted.cpt";

duchamp.showDialog(
        {
                title:"销量弹窗",
                width: 700,
                height: 500,
                innerContent:iframe,
                dialogType:"center",
        }
);

示例3：打开一个标题为“销量弹窗”，宽 500，高 500 ，弹窗内容为内置模板 GettingStarted.cpt 的动态显示弹出框

"use document"
const iframe = document.createElement("iframe");
iframe.width = "100%";
iframe.height = "100%";
iframe.scrolling = "no";
iframe.style="border: none";
iframe.src = "/webroot/decision/view/report?viewlet=GettingStarted.cpt";

duchamp.showDialog({
  title: "销量弹窗",
  width: 500,
  height: 500,
  innerContent: iframe,
  padding: "15px",
  titleStyle: { fontSize: "24px",color:"white", fontWeight: "bold" },
  backgroundStyle: { background:"green" },
  dialogType:"dynamic",
  line: { type: "color", value: { color: "red" } },
  coordinate: [300, 240],
});

参考上述 示例2 和 示例3 制作模板，效果如下图所示：

点击下载模板：JS实现点击打开弹出框.fvs

参数 name 仅用于获取三维组件模型mesh对象名称，返回对象坐标。例如：

duchamp.getWidgetByName("三维组件名称").getCoordinate("模型名称");

不传参时，获取组件中心坐标。例如：

duchamp.getWidgetByName("组件名称").getCoordinate();

示例1：点击标题，获取标题组件坐标，在该坐标位置打开一个带有引导线的弹出框

const coordinate = duchamp.getWidgetByName("标题1_页面1").getCoordinate();
duchamp.showDialog({
  title: "销量弹窗",
  width: 700,
  height: 500,
  innerContent: "Hello World",
  padding: "15px",
  titleStyle: { fontSize: "24px", fontWeight: "bold" },
  backgroundStyle: { background: "green" },
  coordinate:coordinate,
  dialogType: "dynamic",
});

示例2：获取三维组件「停车场模型」中的「车辆002」模型对象的坐标，在该坐标位置打开一个弹出框 注：此方法打开的弹出框不会跟随模型缩放或视角变化而移动位置

const coordinate = duchamp.getWidgetByName("停车场模型").getCoordinate("车辆002");
duchamp.showDialog({
  title: "车辆信息弹出框",
  width: 500,
  height: 300,
  innerContent: "Hello World",
  padding: "15px",
  titleStyle: { fontSize: "24px", fontWeight: "bold" },
  backgroundStyle: { background: "green" },
  coordinate:coordinate,
  dialogType: "dynamic",
});

示例3：获取三维组件「停车场模型」中的「车辆002」模型对象的坐标，在该坐标位置打开一个弹出框 注：此方法打开的弹出框会跟随模型缩放或视角变化而移动位置

duchamp.getWidgetByName("停车场模型").showDialogByMesh({
  title: "车辆信息弹出框",
  width: 500,
  height: 300,
  innerContent: "Hello World",
  padding: "15px",
  titleStyle: { fontSize: "24px", fontWeight: "bold" },
  backgroundStyle: { background:"green" },
  meshName:"车辆002",
});

参考上述 示例2 和 示例3 制作模板，效果如下图所示：

点击下载模板：JS实现获取组件坐标后打开弹出框.fvs

普通报表、决策报表示例：

FR.closeDialog();

FVS 模板示例1：

duchamp.closeDialog();

FVS 模板示例2：打开弹窗后，在弹窗内模板关闭父页面弹窗

window.parent.duchamp.closeDialog();

弹窗选择数据后，自动关闭已经打开的对话框：

详细内容介绍可参考：JS实现弹窗后数据回填

URL ：object

config ：object

target ：object

feature ：object

注：11.0.10 及以后版本参数支持 json 格式，如下：

{

URL ：object

config ：object

target ：object

feature ：object

}

URL：URL 或 Json 超链定义，必填

支持的绝对路径如：

http://192.168.100.1:8080/webroot/decision/view/report?viewlet=GettingStarted.cpt

相对路径如：/webroot/decision/view/report?viewlet=GettingStarted.cpt

config：传递的参数，可以不写

target：超链子页的打开位置，可以不写

• _dialog：对话框
  

• ­_self：当前页

• 某个 iframe 的 name，当前页打开，post 方式提交
  

feature：超链打开位置的属性，可以不写

注：移动端不支持 target 和 feature 参数效果

打开内置模板 GettingStarted.cpt，一个为“销售报表”，传递参数“华东”和是否显示参数面板，打开方式为对话框，对话框宽 700、高 500：

FR.doHyperlinkByGet({
	//报表路径
	"url":"/webroot/decision/view/report?viewlet=GettingStarted.cpt",
	//参数
	"para":{
		"地区":"华东"
		},
	"target":"_dialog",    //对话框方式打开
	"feature":{
		"width":700,
		"height":500,
		"title":"销售报表"
		}
	})

点击按钮，打开标题为“销售报表”，内容为华东地区销量情况，宽 700、高 500对话框：

 详细内容介绍可参考：JS实现对话框打开超链

url:object

para:object

target:object

feature:object

URL：URL 或 Json 超链定义，必填

支持的绝对路径如：

http://192.168.100.1:8080/webroot/decision/view/report?viewlet=GettingStarted.cpt

相对路径如：/webroot/decision/view/report?viewlet=GettingStarted.cpt

para：传递的参数，选填

target：超链子页的打开位置，选填，默认为 _dialog

• _dialog：对话框
  

• ­_self：当前页

• 某个 iframe 的 name，当前页打开，post 方式提交
  

feature：超链打开位置的属性，选填

打开内置模板 GettingStarted.cpt，一个为“销售报表”，传递参数“华东”和是否显示参数面板，打开方式为对话框，对话框宽 700、高 500：

duchamp.doHyperlinkByGet({
	//报表路径
	"url":"/webroot/decision/view/report?viewlet=GettingStarted.cpt",
	//参数
	"para":{
		"地区":"华东"
		},
	"target":"_dialog",    //对话框方式打开
	"feature":{
		"width":700,
		"height":500,
		"title":"销售报表"
		}
	})

点击按钮，打开标题为“销售报表”，内容为华东地区销量情况，宽 700、高 500对话框：

点击下载模板：Get 方法打开对话框.fvs

URL ：object

config ：object

target ：object

feature ：object

URL：URL 或 Json 超链定义，必填

支持的绝对路径如：

http://192.168.100.1:8080/webroot/decision/view/report?viewlet=GettingStarted.cpt

相对路径如：

/webroot/decision/view/report?viewlet=GettingStarted.cpt

config：传递的参数，可以不写

target：超链子页的打开位置，可以不写

• _dialog：对话框
  

• ­_self：当前页

• 某个 iframe 的 name，当前页打开， post 方式提交

feature：超链打开位置的属性，可以不写

注：移动端不支持 target 和 feature 参数效果。

打开内置模板 GettingStarted.cpt，一个为“销售报表”，传递参数“华东”和是否显示参数面板，打开方式为对话框，对话框宽 700、高 500：

FR.doHyperlinkByPost({
	//报表路径
	"url":"/webroot/decision/view/report?viewlet=GettingStarted.cpt",
	//参数
	"para":{
		"地区":"华东"
		},
	"target":"_dialog",    //对话框方式打开
	"feature":{
		"width":700,
		"height":500,
		"title":"销售报表"
		}
	})

点击按钮，打开标题为“销售报表”，内容为华东地区销量情况，宽 700、高 500对话框：

详细内容介绍可参考：JS实现对话框打开超链

URL ：object

config ：object

target ：object

feature ：object

URL：URL 或 Json 超链定义，必填

支持的绝对路径如：

http://192.168.100.1:8080/webroot/decision/view/report?viewlet=GettingStarted.cpt

相对路径如：

/webroot/decision/view/report?viewlet=GettingStarted.cpt

config：传递的参数，选填

target：超链子页的打开位置，选填，默认为 _dialog

• _dialog：对话框
  

• ­_self：当前页

• 某个 iframe 的 name，当前页打开， post 方式提交

feature：超链打开位置的属性，可以不写

打开内置模板 GettingStarted.cpt，一个为“销售报表”，传递参数“华东”和是否显示参数面板，打开方式为对话框，对话框宽 700、高 500：

duchamp.doHyperlinkByPost({
	//报表路径
	"url":"/webroot/decision/view/report?viewlet=GettingStarted.cpt",
	//参数
	"para":{
		"地区":"华东"
		},
	"target":"_dialog",    //对话框方式打开
	"feature":{
		"width":700,
		"height":500,
		"title":"销售报表"
		}
	})

点击按钮，打开标题为“销售报表”，内容为华东地区销量情况，宽 700、高 500对话框：

点击下载模板：Post 方法打开对话框.fvs

见：doURLPrint

自定义打印按钮，以「零客户端」方式打印报表：

需调用其方法使用，详细内容可见 ：Msg

见：Msg

见：Msg

公式

普通报表、决策报表调用 FR 中 sum 函数对 A1、A2 求和：

FR.remoteEvaluate("sum(A1,A2)");

普通报表、决策报表调用 FR 中字符串拼接函数 CONCATENATE 拼接字符串

FR.remoteEvaluate('CONCATENATE("001","1201110")');

FVS 模板示例（支持 V1.15.0 及之后版本）：

duchamp.remoteEvaluate("sum(A1,A2)");

注1：若数据集中包含数据集参数，使用接口 FR.remoteEvaluate(value("ds1",1,1)) 获取数据集的值，FRM/CPT 中根据参数变化获取最新值，FVS V2.0.1 之前版本 和 V2.10.0 及之后版本支持获取最新值，V2.0.1 至 V2.9.0 版本仅支持获取最初的默认值。

注2：在 FVS 日期控件中使用时，需设置返回值为字符串。

不支持移动端

必填，需要转码的字符串

对报表路径进行  jsonEncode 编码

普通报表、决策报表示例：

FR.jsonEncode("/webroot/decision/view/report?viewlet=GettingStarted.cpt");

FVS 模板示例：

duchamp.jsonEncode("/webroot/decision/view/report?viewlet=GettingStarted.cpt");

必填，需要解码的字符串

对 jsonEncode 转码过的报表路径进行解码

普通报表、决策报表示例：

FR.jsonDecode(FR.jsonEncode(
"/webroot/decision/view/report?viewlet=GettingStarted.cpt");

FVS 模板示例：

duchamp.jsonDecode(duchamp.jsonEncode(
"/webroot/decision/view/report?viewlet=GettingStarted.cpt");

Ajax 参数，JSON 格式，说明见：ajax

见：ajax

对象

是否为空，布尔型

• true ：是

• false：否
  

1）查看「文本框控件」text0 是否存在

普通报表、决策报表（参数面板中的控件）示例：

var a = FR.isEmpty(_g().getParameterContainer().getWidgetByName("text0"));
alert(a);

FVS 模板示例：

var a = duchamp.isEmpty(duchamp.getWidgetByName("text0"));
alert(a);

2）查看「文本框控件」text0 是否为空值

普通报表、决策报表（参数面板中的控件）示例：

var a = FR.isEmpty(_g().getParameterContainer().getWidgetByName("text0").getValue());
alert(a);

FVS 模板示例：

var a = duchamp.isEmpty(duchamp.getWidgetByName("text0").getValue());
alert(a);

对象

是否为空，布尔型

• true ：是

• false：否

定义一个数组，查看其是否为数组

普通报表、决策报表示例：

var txt = new Array("I","love","FR");
FR.isArray(txt);

FVS 模板示例：

var txt = new Array("I","love","FR");
alert(duchamp.isArray(txt));

单元格编号

行列索引，json 格式

• col：列索引，从 0 开始

• row：行索引，从 0 开始

示例1：普通报表或决策报表中，返回 A1 单元格的行列信息

FR.cellStr2ColumnRow("A1");

示例2：普通报表或决策报表中，打印 A1 单元格的行号

var a=FR.cellStr2ColumnRow("A1").row+1;
FR.Msg.alert("提示", "A1单元格的行号为"+a);

示例3：FVS 模板中，打印单元格的行列号

var a=duchamp.cellStr2ColumnRow("A3").col+1;
var b=duchamp.cellStr2ColumnRow("A3").row+1;
//alert(a);
duchamp.Msg.alert({
    title: "提示",
    message:  "A3单元格的列号为"+a,
});
duchamp.Msg.alert({
    title: "提示",
    message:  "A3单元格的行号为"+b,
});

普通报表示例：点击按钮，打印  A1 单元格的行号

FVS 模板示例：点击按钮，打印 A3 单元格的行列号

点击下载模板：打印单元格的行列号.fvs

行列索引，json 格式

• col：列索引，从 0 开始

• row：行索引，从 0 开始

单元格编号

示例1：普通报表或决策报表中，返回行索引为 3，列索引为 1 的单元格编号

FR.columnRow2CellStr({col:1, row:3});

示例2：普通报表或决策报表中，打印行索引为 3，列索引为 1 的单元格编号

var a=FR.columnRow2CellStr({col:1, row:3})
FR.Msg.alert("提示", "行索引3，列索引为1的单元格编号为"+a);

示例3：FVS 模板中，打印行索引为 3，列索引为 1 的单元格编号

var a=duchamp.columnRow2CellStr({col:1, row:3})
duchamp.Msg.alert({
    title: "提示",
    message:  "行索引3，列索引为1的单元格编号为"+a,
});

普通报表示例：打印行索引为 3，列索引为 1 的单元格编号

FVS 模板示例：打印行索引为 3，列索引为 1 的单元格编号

点击下载模板：根据行列号获取单元格编号.fvs