Report Events
Information |
Since dashboards and reports use the same unified template format - MRT, methods for loading the template and working with data, the word “report” will be used in the documentation text.
|
In order to write interactive applications it is needed to respond to changes in the application. The event system which is represented in StiReport object can be used for this. The following events exist:
onPrepareVariables
Asynchronous event is called before filling in the variables in the report at the beginning of the report rendering. The event handler argument “event” is an object with the next fields:
|
onBeginProcessData
Asynchronous event is called before requesting the data for the report. The event handler argument “event” is an object with the next fields:
|
onEndProcessData
Is called after retrieving data for the report. The event handler argument “event” is an object with the next fields:
|
onBeginRender
Is called at the beginning of the report rendering. This is not relevant for the dashboards.
|
onRendering
Is called at the report is rendering when each report page is created. This is not relevant for the dashboards.
|
onEndRender
Is called at the ending of the report rendering. This is not relevant for the dashboards.
|
onExportingRender
Is called before a report export is started.
|
onExportedRender
Is called after a report export is ended.
|
onPrinting
Is called when report.print() or report.printToPdf() method is invoked. This is not relevant for the dashboards.
|
onPrinted
Asynchronous event is called when report.print() or report.printToPdf() method is invoked after a report is exported to Html or PDF file (depends on method type). This is not relevant for the dashboards. The event handler argument “event” is an object with the next fields:
|
onRefreshing
Is called after a report is rendered if report.refreshTime property is set more than zero. Also, this event is called when Refresh button is clicked in the viewer. |