JS API Summary

11.0.10

General reports are supported in report block object interfaces, report block row/column object interfaces, and report block cell object interfaces.

11.0.7

The FineVis Data Visualization plugin of V1.8.0 and later versions is adapted for some interfaces. For details, see JS API Supported by FVS Dashboard.

11.0.7

Added multiple report block interfaces for dashboards.

11.0.3

Added an interface to get the currently displayed chart in the chart object interfaces.

11.0.2

Added interfaces for chart effects.

11.0

/

_g()

Get the report object, and then this interface is used together with the methods of the report object.

Supported

Supported 

The range and methods supported in 10.0 are limited, while some methods are added in 11.0.

getParameterContainer

Get the parameter panel object in the report, and then this interface is used together with the parameter panel interfaces.

Supported

Not supported 

This interface is newly added in 11.0.

parameterCommit

Re-query and refresh the report after the parameters are submitted.

Supported

Supported

loadContentPane

Reload and refresh the report.

Supported

Supported

getPreviewType

Get the current preview mode of the report.

Supported

Not supported 

This interface is newly added in 11.0.

servletURL

Get servletURL.

Supported

Not supported 

This interface is newly added in 11.0.

serverURL

Get serverURL.

Not supported

Not supported 

This interface is newly added in 11.0.

server

Get server.

Not supported

Not supported 

This interface is newly added in 11.0.

fineServletURL

Get fineServletURL.

Not supported

Not supported 

This interface is newly added in 11.0.

SessionMgr.get

SessionID

Get sessionID.

Supported

Not supported 

This interface is newly added in 11.0.

showDialog

Open a dialog box.

Not supported

Supported

closeDialog

Close a dialog box.

Not supported

Supported

doHyperlinkByGet

Open a webpage by the GET method, on which you can establish parameter linkage and set page attributes.

Supported

Supported

doHyperlinkByPost

Open a webpage by the POST method, on which you can establish parameter linkage and set page attributes.

Supported

Supported

doURLPrint

Call up the printing tool to print reports.

Not supported

Supported

Msg

FineReport has built-in message boxes (with a unified style) that can replace the alert, confirm, and prompt pop-up boxes in Windows.

Supported

Supported

remoteEvaluate

Execute FineReport built-in formulas to get the calculation result.

Supported

Supported

jsonEncode

Encode the string using jsonEncode.

Not supported

Supported

jsonDecode

Encode the string using jsonEncode.

Not supported

Supported

ajax

Encapsulated jQuery.ajax() function

Supported

Supported

isEmpty

Check if the object is empty.

Not supported

Supported

isArray

Check if the object is an array.

Not supported

Supported

location

Locate and get latitude and longitude, which can be used in HTTPS.

Supported

Supported

Mobile.getDeviceInfo

Get device information.

Supported

Supported

signOut

Log out of the decision-making platform, namely returning to the platform login page.

Not supported

Supported

tabPane.closeActiveTab

Close the tab page of the decision-making platform, namely automatically closing the template previewed in the platform.

Supported

Supported

tabPane.addItem

Open a new tab page in the decision-making platform.

Supported

Supported

getWidgetByName

Get the widget in the parameter panel, and then this interface is used together with the methods for widgets.

Supported

Supported 

Note that there have been changes in the interface for getting the parameter panel.

collapse

Collapse the parameter panel.

Supported

Not supported 

This interface is newly added in 11.0.

expand

Expand the parameter panel.

Supported

Not supported

This interface is newly added in 11.0.

submit

Query after auto-ssubmission

Supported

Not supported

This interface is newly added in 11.0.

this

Get the current widget object in the event of the widget, and then this interface can be used together with the methods and attributes of the widget.

Supported

Supported

this.options.form

Called in the event of the widget, and this interface can be used together with all methods of parameter panel interfaces.

Supported

Supported

getValue

Get the actual value of widgets.

Supported

Supported

getText

Get the display value of widgets.

Supported

Supported

setValue

Set the value of widgets.

Supported

Supported

visible

Show widgets.

Supported

Supported

invisible

Hide widgets.

Supported

Supported

setVisible

Show/hide widgets.

Supported

Supported

isVisible

Whether the widget is visible or not

Supported

Supported

setEnable

Set widgets enabled/disabled.

Supported

Supported

isEnabled

Whether the widget is enabled or not

Supported

Supported

reset

Clear widget content to reset it.

Supported

Supported

getType

Get the widget type.

Supported

Not supported 

This interface is newly added in 11.0.

setWaterMark

Add watermark text (Only widgets with input boxes are supported.).

Supported

Not supported 

This interface is newly added in 11.0.

fireEvent

Call widget events.

Supported

Supported

setPopupStyle

Set the style of the dropdown option box of widgets (Only widgets with option boxes are supported.).

Not supported

Not supported

This interface is newly added in 11.0.

return false

Add return false in specific events of widgets to prevent triggering linkage and query.

Not supported

Supported

setMaxAndMinDate

Set the selectable date range for date widgets.

Supported

Not supported

This interface is newly added in 11.0.

setPopupStyle

Set the style of the pop-up box (Only widgets with pop-up boxes are supported.).

Not supported

Not supported

This interface is newly added in 11.0.

doClick

Trigger the click event of a button, equivalent to manually clicking.

Supported

Not supported

This interface is newly added in 11.0.

setName4Empty

Modify the default text (Select None) displayed in an expanded drop-down box widget.

Not supported

Not supported

This interface is newly added in 11.0.

startMarquee

Enable marquee effect.

Not supported

Supported in 10.0.19 and later versions.

stopMarquee

Disable marquee effect.

Not supported

Supported in 10.0.19 and later versions.

setHScrollBarVisible

Set the horizontal scroll bar to show/hide.

Not supported

Supported in 10.0.19 and later versions.

setVScrollBarVisible

Set the vertical scroll bar to show/hide.

Not supported

Supported in 10.0.19 and later versions.

getCell(row,col)

Get the cell object in the row row and the col column of a report block.

Supported

Not supported

This interface is newly added in 11.0.

getRow(index)

Get all cell objects in the index row of a report block.

Supported

Not supported

This interface is newly added in 11.0.

getColumn(index)

Get all cell objects in the index column of a report   block.

Supported

Not supported

This interface is newly added in 11.0.

getRowCount()

Get the number of rows (after being expanded) in a report block.

Supported

Not supported

This interface is newly added in 11.0.

getColumnCount()

Get the number of columns (after being expanded) in a report block.

Supported

Not supported

This interface is newly added in 11.0.

onMouseClick(func)

Bind cursor/finger click events. If a report block is clicked by the cursor/finger, the bound event is triggered.

Not supported

Not supported

This interface is newly added in 11.0.

onMouseMoveInCell(func)

Bind the event of cursor/finger moving into cells. If the cursor/finger moving into cells, the bound event is triggered.

Not supported

Not supported

This interface is newly added in 11.0.

onMouseMoveOutCell(func)

Bind the event of cursor/finger moving out of cells. If the cursor/finger moves out of cells, the bound event is triggered.

Not supported

Not supported

This interface is newly added in 11.0.

scrollTo(opts)

Set a report block to automatically being scrolled to a certain position.

Supported

Not supported

This interface is newly added in 11.0.

getScrollOffset()

Get the position where a report block is scrolled to.

Supported

Not supported

This interface is newly added in 11.0.

setRadius(radius, range, single)

Set round corners for all cells in a report, and cells must have a background color, otherwise the effect cannot be seen.

Not supported

Not supported

This interface is newly added in 11.0.

showToolTip(opts)

Set tooltips for all cells in a report block.

Not supported

Not supported

This interface is newly added in 11.0.

setHeight(height)

Set the row height of cells.

Not supported

Not supported

This interface is newly added in 11.0.

getHeight()

Get the row height of cells.

Supported

Not supported

This interface is newly added in 11.0.

getCell(col)

Get the cell object in the col column of a certain row in a spreadsheet.

Supported

Not supported

This interface is newly added in 11.0.

setWidth(width)

Set the column width of cells.

Not supported

Not supported

This interface is newly added in 11.0.

getWidth()

Get the column width of cells.

Supported

Not supported

This interface is newly added in 11.0.

getCell(row)

Get the cell object in the row row of a certain column in a spreadsheet.

Supported

Not supported

This interface is newly added in 11.0.

getIndex()

Get the position index of the cell row/column objects.

Supported

Not supported

This interface is newly added in 11.0.

setStyle(opts)

Set the style of cell row/column objects.

Not supported

Not supported

This interface is newly added in 11.0.

showToolTip(opts)

Add tooltips to cell rows/columns of report blocks.

Supported

Not supported

This interface is newly added in 11.0.

getPosition()

Get the current cell's position information. You need to first get the cell object before using this interface.

Supported

Not supported

This interface is newly added in 11.0.

getRow()

Get the cell objects of a row containing the current cell.

Supported

Not supported

This interface is newly added in 11.0.

getColumn()

Get the cell objects of a column containing the current cell.

Supported

Not supported

This interface is newly added in 11.0.

getValue()

Get the value of a cell.

Supported

Not supported

This interface is newly added in 11.0.

showToolTip(opts)

Add a tooltip to a cell.

Not supported

Not supported

This interface is newly added in 11.0.

setStyle(opts)

Set the style of a cell object.

Not supported

Not supported

This interface is newly added in 11.0.

addEffect

type: 'highlightRow', indicating that the color of the row (containing the cell) changes if you click or hover the cursor over a cell.

Supported

Not supported

This interface is newly added in 11.0.

type: 'highlightCol', indicating that the color of the column (containing the cell) changes if you click or hover the cursor over a cell.

Supported

Not supported

This interface is newly added in 11.0.

type: 'highlightCross', indicating that the color of the row and column (containing the cell) changes if you click or hover the cursor over a cell.

Supported

Not supported

This interface is newly added in 11.0.

type: 'highlightCell', indicating that the cell color changes if you click or hover the cursor over a cell.

Supported

Not supported

This interface is newly added in 11.0.

addEffect

type: 'setCellFont', indicating that the cell font format changes if you click or hover the cursor over a cell.

Supported

Not supported

This interface is newly added in 11.0.

type: 'setRowFont', indicating that the font format of the row (containing the cell) changes if you click or hover the cursor over a cell.

Supported

Not supported

This interface is newly added in 11.0.

The font of the row (containing the cell) changes if you click or hover the cursor over a cell. The font restores to its original state if you click or hover the cursor over other rows.

Supported

Not supported

This interface is newly added in 11.0.

addEffect

type: 'setCellFont', indicating that a text/image tooltip box appears if you hover the cursor over a cell.

Not supported

Not supported

This interface is newly added in 11.0.

setRowHeight

Change cell row height.

Not supported

Not supported

This interface is newly added in 11.0.

setColWidth

Change cell column width.

Not supported

Not supported

This interface is newly added in 11.0.

getCellValue

Get the value of a specific cell. The parameter can be the cell address or the row and column number of the cell.

Supported partially

Supported

This interface can be used only in data entry in 10.0.

setCellValue

Assign the value of a specific cell. The parameter can be the cell address or the row and column number of the cell.

Supported partially

Supported

This interface can be used only in data entry in 10.0.

setCellRadius

Set round corners for all cells in a report, and cells must have a background color, otherwise the effect cannot be seen.

Not supported

Not supported

This interface is newly added in 11.0.

Chart.WebUtils.getChart

Get the chart block object.

Supported

Supported

getChartWithIndex

Get the chart object.

Supported

Supported

getCurrentChartIndex

Get the chartIndex of the currently displayed chart.

Not supported

Supported in 10.0.19   and later versions.

series

Get the series object.

JS can be called on partial mobile terminals.

Supported

series.points

Get the data point object.

Not supported

Supported

setSeriesVisible

Display partial chart series.

Supported

Supported

openAutoTooltip

Set carousel for data point tooltips.

Not supported

Supported

dataRefresh

Refresh the chart.

Supported

Supported

showIndexChart

Switch to the specified chart object.

Supported

Supported

switchCarouselChart

Switch to the previous (or next) chart object.

Supported

Supported

VanCharts.unifiedSwitchCarouselChart

Switch carousel charts uniformly.

Not supported

Supported

sortChart

Sort the chart.

Not supported

Supported

saveAsImage

Export the chart.

Not supported

Not supported

setMapZoom

Set map zoom level and its center point.

Not supported

Supported

getZoom

Get the zoom level.

Not supported

Supported

getCenter

Get the center point.

Not supported

Supported

panTo

Transfer the map center point.

Not supported

Supported

drillDown

Drill down.

Not supported

Supported

drillUp

Drill up.

Not supported

Not supported

getLayerIndex

Get the current drill level. The level starts from 0 (such as 0, 1, 2...).

Not supported

Not supported

getLayerNames

Get the drill directory name, with the result being an array, such as ["Aisa", "Thailand", "Bangkok"].

Not supported

Not supported

changeParameter

Change the chart parameters and re-assign values.

Not supported

Supported

getWidgetByName

Get the button in the report toolbar and then this interface can be used together with the methods for buttons.

Not supported

Supported

getToolbar (for   general reports)

Get the toolbar object.

Supported

Not supported

This interface is newly added in 11.0.

getToolbar(index)   (for dashboards)

Get the toolbar of the report block. This interface is used when the toolbar is displayed.

Supported

Not supported

This interface is newly added in 11.0.

toolBarFloat

Set the toolbar display position.

Not supported

Not supported

This interface is newly added in 11.0.

setStyle

Resize the toolbar.

Not supported

Not supported 

This interface is newly added in 11.0.

setVisible

Set the toolbar to show/hide.

Supported

Not supported

This interface is newly added in 11.0.

visible

Show a certain toolbar button.

Not supported

Supported

invisible

Hide a certain toolbar button.

Not supported

Supported

setVisible

Show/hide a certain toolbar button.

Not supported

Supported

isVisible

Whether a certain toolbar button is visible

Not supported

Supported

setEnable

Enable/disable a certain toolbar button.

Not supported

Supported

isEnabled

Whether a certain toolbar button is enabled

Not supported

Supported

changeFormat

Modify the options of format supported in email.

Not supported

Not supported

This interface is newly added in 11.0.

gotoPreviousPage

Go back to the previous page.

Supported

Supported

gotoNextPage

Jump to the next page.

Supported

Supported

gotoLastPage

Jump to the last page.

Supported

Supported

gotoFirstPage

Jump to the first page.

Supported

Supported

gotoPage

Jump to a specified page.

Supported

Supported

getCurrentPageIndex

Get the current page number.

Supported

Not supported

This interface is newly added in 11.0.

getReportTotalPage

Get total number of pages.

Supported

Not supported

This interface is newly added in 11.0.

currentPageIndex

Page number of the current page in a report.

Supported

Supported

reportTotalPage

Total number of pages in a report.

Supported

Supported

exportReportToExcel

Export a report in Excel format.

Supported partially

Supported

exportReportToImage

Export a report as an image file.

Supported partially

Supported

exportReportToPDF

Export a report in PDF format.

Supported partially

Supported

exportReportToWord

Export a report in Word format.

Supported partially

Supported

expandNodeLayer

Expand the collapsed tree to the N layer of nodes.

Not supported

Supported only in FineReport equipped with the Engine-X plugin of V1.6.0 and later versions

collapseNodeLayer

Fold the collapsed tree to the N layer of nodes.

Not supported

Supported only in FineReport equipped with the Engine-X plugin of V1.6.0 and later versions

expandAllNodeLayer

Expand all nodes of the collapsed tree.

Not supported

Not supported

collapseAllNodeLayer

Fold all nodes of the collapsed tree.

Not supported

Not supported

getWidgetByName

Get the widget in the filling cell by its name.

Supported

Supported

getWidgetByCell

Get the widget in the filling cell by the cell address.

Supported

Supported

getWidgetsByName

Get the widgets with the same name in the filling cell by its name.

Supported

Supported

appendReportRC

Insert rows at a specific position.

Not supported

Supported

appendReportRow

Insert rows.

Supported

Supported

deleteReportRC

Delete rows.

Not supported

Supported

deleteRows

Delete rows.

Not supported

Supported

refreshAllSheets

Re-query to refresh all sheets. The last viewed sheet retains after the refresh.

Supported

Supported

loadSheetByIndex

Switch to a specified sheet, with the parameter being the sheet index.

Not supported

Supported

loadSheetByName

Switch to a specified sheet, with the parameter being the sheet name.

Not supported

Supported

isDirtyPage

Check whether the page has been edited.

Not supported

Supported

isAutoStash

Check whether automatic stashing is enabled. For details, see Data Entry Stash (Temporary Storage).

Not supported

Supported

writeReport

Submit a report forcibly without validation.

Supported

Supported

verifyAndWriteReport

Validate and submit a report.

Supported

Supported

verifyReport

Data validation

Supported

Supported

importExcel

Import an Excel file.

Not supported

Supported

importExcel_Append

Import an Excel file by Incremental Import.

Not supported

Supported

importExcel_Clean

Import an Excel file by Clean Import.

Not supported

Supported

importExcel_Cover

Import an Excel file by Override Import.

Not supported

Supported

stash

Stash data.

Not supported

Supported

clear

Clear cached data.

Not supported

Supported

centerReport

Set a report to be displayed in the center during data analysis preview.

Not supported

Not supported

This interface is newly added in 11.0.

expandNodeLayer

Expand the collapsed tree to the N layer of nodes during data analysis preview.

Not supported

Not supported

This interface is newly added in 11.0.

collapseNodeLayer

Fold the collapsed tree to the N layer of nodes during data analysis preview.

Not supported

Not supported

This interface is newly added in 11.0.

expandAllNodeLayer

Expand all nodes of the collapsed tree during data analysis preview.

Not supported

Not supported

This interface is newly added in 11.0.

collapseAllNodeLayer

Fold all nodes of the collapsed tree during data analysis preview.

Not supported

Not supported

This interface is newly added in 11.0.

getAllWidgets

Get all component information from a report object.

Supported

Not supported

This interface is newly added in 11.0.

getWidgetByName

Get a component from a report object, and get components from the body and widgets from the parameter panel.

Supported

Supported

visible

Show widgets.

Supported

Supported

invisible

Hide widgets.

Supported

Supported

setVisible

Show/hide widgets.

Supported

Supported

isVisible

Return that whether a component is visible

Supported

Supported

showCardByIndex

Get the position index of the currently displayed tab page.

Supported

Supported

setTabVisible

Show/hide a specific tab page.

Supported

Supported

getShowIndex

Show/hide a tab block title.

Supported

Supported

setTitleVisible

Display the Nth tab page.

Not supported

Supported