Global API - FS

11.0

No changes and all the following APIs are supported in V10.0.

signOut()

To log out of the decision-making system, that is, to return to the system login page.

Note:

Templates that use this API must be opened within the decision-making system. Direct preview is not supported.

/

/

void

You can add the following code to a template and mount the template to the directory of the decision-making system. When you preview the template, the system will automatically log you out.

window.parent.FS.signOut();

You can mount the built-in template GettingStartedEN.cpt to the directory of the decision-making system. When you preview the template, you will be redirected to the system login page.

This API is not supported on mobile terminals.

Note:

To log out of the decision-making system on mobile terminals, you can use the FR.logoutApp() API. For details, see [General] Logging out of the System by JS.

tabPane.closeActiveTab()

To close the tab page of the decision-making system, that is, to automatically close the template being previewed in the system.

/

/

void

You can add the following code to a template and mount the template to the directory of the decision-making system. When you preview the template, the template will be closed.

window.parent.FS.tabPane.closeActiveTab();

You can mount the built-in template GettingStartedEN.cpt to the directory of the decision-making system. When you preview the template, the corresponding tab page will be automatically closed after two seconds.

For general reports and FRM reports, this API is supported on mobile terminals. For FVS dashboards, this API is supported on mobile terminals only when the FineVis Data Visualization plugin is V2.6.0 or later.

tabPane.addItem(entry)

To open a new tab page in the decision-making system.

Note:

This API is not supported for hyperlinks of reports in dialog boxes.

entry

{title: String,

 src: String}

entry: an entry object corresponding to the tab item, which is required and in JSON format

• title: title of the tab page, which is a string

• src: the URL of the tab content, which is a string

void

Example One: You can open a tab page on the platform with the title baidu and the URL https://www.baidu.com.

window.parent.FS.tabPane.addItem({title:"baidu",src:"https://www.baidu.com"});

Example Two: You can open a CPT file on the platform with the title Order Details and the file path demo/Basic/Sub_Drill Down Report_Order Details.cpt.

window.parent.FS.tabPane.addItem
            ({title: "Order Details",
              src: FR.servletURL+"?viewlet=demo/Basic/Sub_Drill Down Report_Order Details.cpt"
})

Note:

When using the above code in FVS templates, replace FR.servletURL with duchamp.servletURL.

For a report in the platform directory, you can click the hyperlink in the main report to open the sub-report in a new tab.

For details, see Opening a Hyperlink on a New Tab Page.

For general reports and FRM reports, this API is supported on mobile terminals. For FVS dashboards, this API is supported on mobile terminals only when the FineVis Data Visualization plugin is V2.6.0 or later.