Viewer Events

The report viewer supports events that provide the ability to perform necessary operations before specific actions—both on the JavaScript client side and the Python server side. A detailed description of how events work can be found in the Report Engine Events section.

Some event arguments take values from enumerations that are located in specific namespaces. All the enumerations used in designer events are listed in the code block below:

app.py

from stimulsoft_reports.enums import StiEventType
from stimulsoft_reports.report.enums import StiExportFormat
from stimulsoft_reports.viewer.enums import StiPrintAction, StiExportAction

viewer.html

<script>
    StiExportAction = Stimulsoft.Viewer.StiExportAction;
    StiExportFormat = Stimulsoft.Report.StiExportFormat;
</script>

The viewer supports the following events:

• onPrepareVariables
• onBeginProcessData
• onEndProcessData
• onOpenReport
• onOpenedReport
• onPrintReport
• onBeginExportReport
• onEndExportReport
• onInteraction
• onEmailReport
• onDesignReport

onPrepareVariables

[v] JavaScript [v] Python

The event is triggered before the report is built, after the report variables are prepared. A list of event arguments can be found in the Report Engine Events section. Detailed descriptions and usage examples can be found in theWorking with Report Variables section.

onBeginProcessData

[v] JavaScript [v] Python

The event is triggered before requesting the data needed to build the report. A list of event arguments can be found in the Report Engine Events section. Detailed descriptions and usage examples can be found in the Connecting Data Files and Connecting SQL Data Adapters sections.

onEndProcessData

[v] JavaScript [v] Python

The event is triggered after the data is loaded, before the report is built. A list of event arguments can be found in the “Report Engine Events” section. Detailed descriptions and usage examples can be found in the Connecting Data Files and Connecting SQL Data Adapters sections.

onOpenReport [v] JavaScript [x] Python

The event is triggered before opening the report after the toolbar button is clicked.

List of properties passed in the event arguments on the JavaScript client-side:

onOpenedReport [v] JavaScript [v] Python

The event is triggered after opening a report from the designer menu but before it is loaded into the viewer.

List of properties passed in the event arguments on the JavaScript client-side:

List of properties passed in the event arguments on the Python server side. The arguments are of type StiReportEventArgs:

onPrintReport

[v] JavaScript [v] Python

The event is triggered before printing the report. The table below shows the list of event handler arguments on the client-side in JavaScript:

The list of properties passed as event arguments on the server side in Python has the type StiReportEventArgs:

For detailed descriptions and usage examples, refer to the Report Printing section.

onBeginExportReport

[v] JavaScript [v] Python

The event is triggered before exporting the report, after the export settings dialog. The table below shows the list of event handler arguments on the client-side in JavaScript:

The list of properties passed as event arguments on the server side in Python has the type StiExportEventArgs:

onEndExportReport

[v] JavaScript [v] Python

The event is triggered after the report has been exported, but before it is saved as a file. The table below shows the list of event handler arguments on the client-side in JavaScript:

The list of properties passed as event arguments on the server side in Python has the type StiExportEventArgs:

onInteraction

[v] JavaScript [x] Python

The event is triggered at the moment of an interactive action in the viewer (dynamic sorting, collapsing, drill-down, applying parameters) before the report generator processes the values. The table below shows the list of event handler arguments on the client-side in JavaScript:

onEmailReport

[v] JavaScript [v] Python

The event is triggered after the report is exported and before it is sent via Email. The table below lists the event handler arguments on the client side in JavaScript:

The table below shows the list of Email sending parameters on the client-side in JavaScript.

List of properties passed in the event arguments on the Python server-side. The arguments are of type StiExportEventArgs:

List of Email sending parameters on the Python server-side. All settings are in the StiEmailSettings class:

onDesignReport

[v] JavaScript [x] Python

The event is triggered when the Design button on the viewer panel is clicked. The table below lists the event handler arguments on the client side in JavaScript: