Global API - FR

11.0

Different from 10.0 in:

11.0 added interfaces including servletURL, serverURL, server, fineServletURL, and SessionMgr.getSessionID().

11.0.7

Added description of FVS template interface.

Applicable to users who have installed the FVS Dashboard Edit Mode plugin of version 1.8.0 and later.

11.0.9

The remoteEvaluate interface supported the FVS Dashboard Edit Mode plugin of version 1.15.0 and later.

11.0.10

showDialog and doHyperlinkByGet parameters supported JSON.

-

-

string

Returns a string in a format like 

/webroot/decision/view/report

For general reports and dashboards:

FR.servletURL;

For FVS templates:

duchamp.servletURL;

-

Supported

There is a difference between the return format of the mobile terminal and the PC terminal, such as /webroot/decision.

-

-

string

Returns a string in a format like

http://localhost:port

For general reports and dashboards:

FR.serverURL;

For FVS templates:

duchamp.serverURL;

-

Not supported

-

-

string

Returns a string in a format like

http://localhost:port/webroot

For general reports and dashboards:

FR.server;

For FVS templates:

duchamp.server;

-

Not supported

-

-

string

Returns a string in a format like

/webroot/decision

For general reports and dashboards:

FR.fineServletURL;

For FVS templates:

duchamp.fineServletURL;

-

Not supported

-

-

string

Returns a string in a format like

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

For general reports and dashboards:

FR.SessionMgr.getSessionID();

For FVS templates:

duchamp.SessionMgr.getSessionID();

Click the button to print the report sessionId.
Click to download the template.

Print sessionId.cpt

Click to download the FVS template. 

Print sessionId.fvs

Supported

title: string

width: number

height: number

innerContent: iframe

Note:

In FineReport 11.0.10 and later versions, the parameters support JSON format, as shown below.

{

title:string,

width:number,

height:number,

innerContent:iframe

}

title: title of the dialog box, string

width: dialog width

height: dialog height

innerContent: dialog content, iframe tage. 

If you want to open a report in the project, you need to add an iframe tag first.

void

Example 1: Open a dialog box with the title "Pop-up Window", width 600, height 400, where the content of the dialog box is "Hello World".  

For general reports and dashboards:

FR.showDialog("Pop-up Window",600,400,"Hello World");

Example 2: Open a dialog box with the title "Region Sales Situation", width 700, height 500, where the content of the dialog box is the built-in template "GettingStarted.cpt".

Note:

Pay attention to avoid code format problems caused by line changes and modify the format when entering long codes in the designer, as shown below. 

For general reports and dashboards:

Create an iframe inside the dialog box. Name the iframe parameter and specify the width and height.
var iframe = $("<iframe id='inp' name='inp' width='100%'
height='100%' scrolling='no' frameborder='0'>");
Add the src attribute to the iframe. Specify the path of the template to be displayed.
iframe .attr("src", "/webroot/decision/view/report?viewlet=GettingStarted .cpt");
Design the pop-up dialog box.
FR.showDialog("Region Sales Situation",700,500, iframe);

Click to button to open a dialog box with the title "Region Sales Situation", width 700, height 500, where the content of the dialog box is the built-in template "GettingStarted.cpt".

For details, see JS implements data backfill after pop-up window.

Not supported

title:string

width:number

height:number

innerContent:iframe

title: title of the dialog box, string

width: dialog width

height: dialog height

innerContent: dialog content, iframe tage. If you want to open a report in the project, you need to add an iframe tag first.

string

Example 1: Open a dialog box with the title "Pop-up Window", width 600, height 400, where the content of the dialog box is"Hello World". 

duchamp.showDialog(
{
title:"Pop-up Window",
width:600,
height:400,
innerContent:"Hello World"
}
)

Example 2: Open a dialog box with the title "Popup of Region Sales Situation", width 700, height 500, where the content of the dialog box is the built-in template "GettingStarted.cpt".

"use document";
const iframe = document.createElement("iframe");
iframe.width = "100%";
iframe.height = "100%";
iframe.scrolling = "no";
iframe.frameborder = "0";
iframe.src = "/webroot/decision/view/report?viewlet=GettingStarted.cpt";
// Design the pop-up dialog box.
duchamp.showDialog(
{
title:"Popup of Region Sales Situation"
width:700,
height:500,
innerContent:iframe,
}
);

Open a dialog box with the title "Popup of Region Sales Situation", width 700, height 500, where the content of the dialog box is the built-in template "GettingStarted.cpt".

Click to download the template.  

Click to open iframe dialog box.fvs

Not supported

-

-

void

For general reports and dashboards:

FR.closeDialog();

For FVS templates:

duchamp.closeDialog();

Once you select the data, the dialog box will automatically close.

For details, see JS implements data backfill after pop-up window.

Not supported

URL: object

config: object

target: object

feature: object

Note:

In FineReport 11.0.10 and later versions, the parameters support JSON format, as shown below.

{

URL: object

config: object

target: object

feature: object

}

URL: URL or JSON hyperlink, required

An example of supported absolute paths:

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

An example of supported relative paths: /webroot/decision/view/report?viewlet=GettingStarted.cpt

config: The parameter to be linked. It can be omitted.

target: The opening path of a hyperlink page. It can be omitted.

• _dialog: Dialog

• _self: Current page

• Name of a certain iframe, which will be opened on the current page, and submitted using the POST method.

feature: The attribute of the hyperlink opening path. It can be omitted.

Note:

The target and feature parameters are not supported on mobile terminals.

void

Open the built-in template GettingStarted.cpt and one report named "Region Sales Situation", where the parameter "East China" is linked, and set whether to display the parameter panel and open the parameter panel as a dialog if it is displayed, with the dialog width 700 and height 500:

FR.doHyperlinkByGet({
//Report path
"url":"/webroot/decision/view/report?viewlet=GettingStarted.cpt",
//Parameter
"para":{
"Region":"East China"
},
"target":"_dialog",    //Open as a dialog
"feature":{
"width":700,
"height":500,
"title":"Region Sales Situation"
}
})

Click the button to open a dialog with the title "Region Sales Situation", width 700, height 500, where the content of the dialog box is the sales data of East China.

For details, see JS Implementation Dialog Box Open Hyperlink.

Supported

url:object

para:object

target:object

feature:object

URL: URL or JSON hyperlink, required.

An example of supported absolute paths:

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

An example of supported relative paths: /webroot/decision/view/report?viewlet=GettingStarted.cpt

para: The parameter to be linked. It can be omitted.

target: The opening path of the hyperlink page. It can be omitted and it defaults to _dialog.

• _dialog: Dialog

• _self: Current page

• Name of a certain iframe, which will be opened on the current page, and submitted using the POST method.

feature: The attribute of the hyperlink opening path. It can be omitted.

void

Open the built-in template GettingStarted.cpt and one report named "Region Sales Situation", where the parameter "California" is linked, and set whether to display the parameter panel and open the parameter panel as a dialog if it is displayed, with the dialog width 700 and height 500:

duchamp.doHyperlinkByGet({
//Report path
"url":"/webroot/decision/view/report?viewlet=GettingStarted.cpt",
//Parameter
"para":{
"Region":"California"
},
"target":"_dialog",    //Open as a dialog
"feature":{
"width":700,
"height":500,
"title":"Region Sales Situation"
}
})

Click the button to open a dialog with the title "Region Sales Situation", width 700, height 500, where the content of the dialog box is the sales data of California.

Click to download the template. 

Use GET to open a dialog box.fvs

Not supported

URL: object

config: object

target: object

feature: object

URL: URL or JSON hyperlink, required.

An example of supported absolute paths:

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

An example of supported relative paths:

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

config: The parameter to be linked. It can be omitted.

target: The opening path of a hyperlink page. It can be omitted.

• _dialog: Dialog

• _self: Current page

• Name of a certain iframe, which will be opened on the current page, and submitted using the POST method.

feature: The attribute of the hyperlink opening path. It can be omitted.

Note:

The target and feature parameters are not supported on mobile terminals.

void

Open the built-in template GettingStarted.cpt and one report named "Region Sales Situation", where the parameter "East China" is linked, and set whether to display the parameter panel and open the parameter panel as a dialog if it is displayed, with the dialog width 700 and height 500:

FR.doHyperlinkByPost({
//Report path
"url":"/webroot/decision/view/report?viewlet=GettingStarted.cpt",
//Parameter
"para":{
"Region":"East China"
},
"target":"_dialog",    //Open as a dialog
"feature":{
"width":700,
"height":500,
"title":"Region Sales Situation"
}
})

Click the button to open a dialog with the title "Region Sales Situation", width 700, height 500, where the content of the dialog box is the sales data of East China.

For details, see JS Implementation Dialog Box Open Hyperlink.

Supported

URL: object

config: object

target: object

feature: object

URL: URL or JSON hyperlink, required.

An example of supported absolute paths:

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

An example of supported relative paths:

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

config: The parameter to be linked. It can be omitted.

target: The opening path of the hyperlink page. It can be omitted and it defaults to _dialog.

• _dialog: Dialog

• _self: Current page

• Name of a certain iframe, which will be opened on the current page, and submitted using the POST method.  

feature: The attribute of the hyperlink opening path. It can be omitted.

void

Open the built-in template GettingStarted.cpt and one report named "Region Sales Situation", where the parameter "California" is linked, and set whether to display the parameter panel and open the parameter panel as a dialog if it is displayed, with the dialog width 700 and height 500:

duchamp.doHyperlinkByPost({
//Report path
"url":"/webroot/decision/view/report?viewlet=GettingStarted.cpt",
//Parameter
"para":{
"Region":"California"
},
"target":"_dialog",    //Open as a dialog
"feature":{
"width":700,
"height":500,
"title":"Region Sales Situation"
}
})

Click the button to open a dialog with the title "Region Sales Situation", width 700, height 500, where the content of the dialog box is the sales data of California.

Click to download the template.

Use POST to open a dialog box.fvs

Not supported

config: object

config: Print parameter. For details about the parameter format, see doURLPrint.

void

See: doURLPrint.

Customize the print button to print reports using "Zero Client Printing".

Not supported

config: object

It shall be used together with other methods. For details, see Msg.

void

See: Msg.

See: Msg.

Supported

formula: String

Formula

object

Call the sum function in FineReport for general reports and dashboards to sum A1 and A2.

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

Call the CONCATENATE function in FineReport to link strings together for general reports and dashboards.

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

For FVS templates (V1.15.0 and later versions are supported):

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

-

Supported

Note:

Starting from version 9.0, the mobile App no longer supports FR.remoteEvaluate(formula), and it will report an error saying "synchronous http requests are not supported".

code:String

String to be encoded, required

String

Encode the report path using jsonEncode.

For general reports and dashboards:

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

For FVS templates:

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

-

Not supported

code:String

String to be encoded, required

String

Decode the report path that has been encoded using jsonEncode.

For general reports and dashboards:

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

For FVS templates:

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

-

Not supported

options

Ajax parameter in JSON format, see ajax.

void

See ajax.

See ajax.

Supported

Object:Object

Object

Boolean

Whether it is empty or not.

true: Yes

false: No

1) Check if the string control named text0 exists.

For general reports and dashboards (widgets in the parameter panel):

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

For FVS templates:

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

2) Check if the string control named text0 is empty.

For general reports and dashboards (widgets in the parameter panel):

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

For FVS templates:

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

-

Not supported

Object:Object

Object

Boolean

Whether it is empty or not.

true: Yes

false: No

Define an array and check if it is an array.

For general reports and dashboards:

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

For FVS templates:

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

-

Not supported

cell

Cell number

{col:colindex, row:rowindex}

Row and column indexes in JSON format

col: Column index, starting from 0

row: Row index, starting from 0

Example 1: Return the row and column information of cell A1 in general reports or dashboards.

FR.cellStr2ColumnRow("A1");

Example 2: Print the row number of cell A1 in general reports or dashboards.

var a=FR.cellStr2ColumnRow("A1").row+1;
FR.Msg.alert("Prompt", "The row number of cell A1 is"+a);

Example 3: Print the row and column number of a cell in FVS templates.

v

ar a=duchamp.cellStr2ColumnRow("A3").col+1;
var b=duchamp.cellStr2ColumnRow("A3").row+1;
//alert(a);
duchamp.Msg.alert({
title: "Prompt",
message:  "The column number of cell A3 is"+a,
});
duchamp.Msg.alert({
title: "Prompt",
message:  "The row number of cell A3 is"+b,
});

For general reports: 

Click the button to print the row number of cell A1.

For FVS templates: 

Click the button to print the row and column number of cell A3.

Click to download the template. 

Print cell row and column information.fvs

Supported

{col:colindex, row:rowindex}

Row and column indexes in JSON format

cell

Cell number

Example 1: Get the cell number of the cell in general reports or dashboards with row index 3 and column index 1.

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

Example 2: Print the cell number of the cell in general reports or dashboards with row index 3 and column index 1.

var a=FR.columnRow2CellStr({col:1, row:3})
FR.Msg.alert("Prompt", "The cell number of the cell with row index 3 and column index 1 is "+a);

Example 3: Print the cell number of the cell in FVS templates with row index 3 and column index 1.

var a=duchamp.columnRow2CellStr({col:1, row:3})
duchamp.Msg.alert({
title: "Prompt",
message: "Row index 3, column index 1 cell number"+a,
});

For general reports: Row index 3, column index 1 cell number is B4

For FVS templates: Print a cell number whose row index is 3 and column index is 1.

Click to download the template. 

Get cell number with column number.fvs

Not supported