Report Viewer

Description

The Report Viewer component provides a way to run and view Reports in Vision windows. Parameters added during Report creation are provided as Properties in the Viewer and can override any default values set in the Report Resource. Right clicking on the Report Viewer brings up a menu that allows you to easily print the report or save it in various formats. The Reporting Module comes with some additional reporting components that can be used with Vision components. To learn more, refer to the Vision Reporting Components section in the Reporting Module. To find documentation on the deprecated Report Viewer prior to Ignition 7.8, see the Legacy Report Viewer documentation.

Properties

Name	Description	Type	Scripting	Category
Background Color	Color that lays underneath the report.	Color	.background	Appearance
Border	The border surrounding this component. NOTE that the border is unaffected by rotation.	Border	.border	Common
Current Page	Current page in the report you would like to view.	Int	.currentPage	Data
Foreground Color	The foreground color the labels on the component.	Color	.foreground	Appearance
Name	The name of this component.	String	.name	Common
Page Count	Number of pages in the report.	Int	.pageCount	Data
Print Mode	Sets the printing mode. Vector is fastest and high-quality for printers that support it, but Raster mode can help spool size with older printers.	Int	.printingMode	Behavior
Report Path	Path in the Project to the Report you would like to view.	String	.reportPath	Data
Show Controls	Show the bar with the page and the zoom controls.	Boolean	.showControls	Appearance
Suggested Filename	The filename that will come up by default when the user saves the report to disk.	String	.suggestedFilename	Behavior
Visible	If disabled, the component will be hidden.	Boolean	.visible	Common
Zoom Factor	Zoom factor for this report.	Float	.zoomFactor	Data

This feature is new in Ignition version 7.9.5
Click here to check out the other new features

The following property was added in 7.9.5

Name	Description	Type	Scripting	Category
Report Loading	Returns true while the report is loading, Note that this property does NOT appear in the Property Editor, but can easily be accessed from a Python script. Useful in scenarios where you wish to change the value of a parameter on the Report Viewer in a script and then do some additional work once the report has finished loading.	Boolean	reportLoading	N/A

Scripting

Scripting Functions

print(printerName, showDialog)

The following print method will only work if a report has finished loading on the Report Viewer component

Description

Uses the named printer and determine if the print dialog window should appear or not.

Parameters

String printerName - The name of the printer the report should be sent to. Will use the default printer if left blank. [optional]

Boolean showDialog - True if the dialog window should appear, False if the dialog window should be skipped. Will be true if left blank. [optional]

Return

Nothing

Scope

Client

getBytesPDF()

Description

Return the bytes of the generated report in the Report Viewer using PDF format.

Parameters

None

Return

Byte Array - The bytes of the report in PDF format.

This function will return null if the trial has expired.

Scope

Client

getBytesPNG()

Description

Return the bytes of the generated report in the Report Viewer using PNG format.

Parameters

Nothing

Return

Byte Array - The bytes of the report in PNG format.

This function will return null if the trial has expired.

Scope

Client

saveAsPDF(fileName)

Description

Prompts the user to save a copy of the report as a PDF. Shows a file selection window with the extension set to PDF.

Parameters

String fileName - A suggested filename to save the report as

Return

Nothing

Scope

Client

saveAsPNG(fileName)

Description

Prompts the user to save a copy of the report as a PNG. Shows a file selection window with the extension set to PNG.

Keyword Args

String fileName - A suggested filename to save the report as.

Return

Nothing

Scope

Client

saveAsXls(fileName)

Description

Prompts the user to save a copy of the report as an XLS file. Shows a file selection window with the extension set to XLS.

Keyword Args

String fileName - A suggested filename to save the report as.

Return

Nothing

Scope

Client

Extension Functions

onReportGenerated

Description

Called when the Report generation process has been completed.

Keyword Args

Component self - A reference to the component invoking this method.

Byte Array pdfBytes - The PDF formatted bytes generated by the Report.

Return

Nothing

Scope

Client

Event Handlers

mouse

mouseClicked

This event signifies a mouse click on the source component. A mouse click the combination of a mouse press and a mouse release, both of which must have occurred over the source component. Note that this event fires after the pressed and released events have fired.

.source	The component that fired this event
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

mouseEntered

This event fires when the mouse enters the space over the source component.

.source	The component that fired this event
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

mouseExited

This event fires when the mouse leaves the space over the source component.

.source	The component that fired this event
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

mousePressed

This event fires when a mouse button is pressed down on the source component.

.source	The component that fired this event
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

mouseReleased

This event fires when a mouse button is released, if that mouse button's press happened over this component.

.source	The component that fired this event
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

mouseMotion

mouseDragged

Fires when the mouse moves over a component after a button has been pushed.

.source	The component that fired this event
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

mouseMoved

Fires when the mouse moves over a component, but no buttons are pushed.

.source	The component that fired this event
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

propertyChange

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

.source	The component that fired this event
.newValue	The new value that this property changed to.
.oldValue	The value that this property was before it changed. Note that not all components include an accurate oldValue in their events.
.propertyName	The name of the property that changed. NOTE: remember to always filter out these events for the property that you are looking for! Components often have many properties that change.

Examples

print()

#calls print on a Report Viewer component located in the same window

reportViewer = event.source.parent.getComponent('Report Viewer')
reportViewer.print()

print() with default printer, no dialog

#calls print on a Report Viewer component located in the same window
#bypasses the print dialog window and uses the default printer

reportViewer = event.source.parent.getComponent('Report Viewer')
reportViewer.print(None, False)

saveAsPDF()

#Saves the file as a PDF to a user selected location. 
#The file selection window defaults to a name of "Daily Report"

reportViewer = event.source.parent.getComponent('Report Viewer')
reportViewer.saveAsPDF("Daily Report")

This feature is new in Ignition version 7.9.5
Click here to check out the other new features

The following example utilizes the reportLoading property, which was introduced in 7.9.5.

Utilizing reportLoading

#This example will change the value of a parameter, wait for a new version of the report
#to generate, and then print the new report. 
#It is assumed that this script is being called from a component-based script, and the source component is in the same container as the Report Viewer

#Reference the report viewer
reportViewer = event.source.parent.getComponent('Report Viewer') 

#Make a change to one of the Report Parameters on the Report Viewer. 
#This will cause a new report to generate.
reportViewer.EndDate = system.date.now()

#We'll call this function once the report has finished loading. 
def finished():
	#We're simply printing the report here, but you could place any amount of work 
	#here that you want to execute once the new report has been generated
	reportViewer.print()		

#We'll use this function to constantly check to see if the report has finished loading
def waiting():

	#While we're waiting....
	while reportViewer.reportLoading:
		#...don't do anything, just keep checking
		pass		
	
	#Once we get to this point, the report has finished loading, so lets call finished()
	#Using invokeLater so we can finish up in the Event Dispatch Thread
	system.util.invokeLater(finished)

#Start the waiting process in an asynchronous thread.
system.util.invokeAsynchronous(waiting)

Customizers

This component does not have any custom properties.

Contents

Strategic Partner Links

Resources

All Manual Versions