Skip to end of metadata
Go to start of metadata


Component Palette Icon:

On this page ...

The Report Viewer component allows embedding reports from the Reporting Module into a Perspective views. The Reporting Module must be installed to use the Report Viewer component. To configure the Report Viewer, you must first create a report and provide the Path of that report in the 'source' property of the component. 

You can specify any parameters that you are using in the report as values under the params property, but the parameter names must match. The values specified will be used instead of the default report parameters.


Interface Elements

IconNameDescription

ZoomControls the zoom level of the PDF view.

PagerDisplays the current page and allows the user to increment or decrement pages.

Download

Downloads the report.

This feature was changed in Ignition version 8.1.12:
As of 8.1.12, after clicking or pressing "Download" the button is disabled until the user either saves the report or cancels the download.

PopoutOpens the report in a new window.

Properties

NameDescriptionProperty Type
source

Path of the report (case sensitive) from the Reporting Module that this component should display.

For example, your Report source path might be: "Folder/ReportName". Right-click on the report in the Project Browser to Copy Path.

value: string
params

An object that can be enhanced with report parameters to use in a report. 

object
pageThe current page number displayed with the report. This property is updated as the pages are viewed.value: numeric
pageCountA read-only property that provides the total number of pages in the report.value: numeric
zoomLevelA number representing the desired zoom level as a percentage of the report width. The Fit Panel option is simply 1 as opposed to a percentage value.value: numeric
allowDownload

If set to 'true,' an icon will be added to the control bar at the bottom of the component that will download the report as a PDF file when clicked.

The value of this property is always treated as "false" when the report viewer component is viewed from the iOS and Android Perspective Mobile apps. 

value: boolean
allowOpenInTab

If set to 'true,' an icon will be added to the control bar at the bottom of the component that will open a temporary PDF file in a new tab.

The value of this property is always treated as "false" when the report viewer component is viewed from Perspective Workstation, as well as the iOS and Android Perspective Mobile apps. 

value: boolean
controlStyle

An object containing CSS style properties that are applied to the control bar and controls across the bottom. 

NameDescriptionProperty Type
classesStyles defined in the project to be applied to this component.object
object
style

An object containing CSS style properties that are applied to the background display of the component.

object


Example

Configuring the Report Viewer

The Report Viewer component provides an easy way to view and print reports in a Perspective View. Let's configure the Report Viewer for a report.

Note: This example requires that you already have a report created in your Gateway. You can learn more about creating reports here.

  1. Drag a Report Viewer component into a view.


  2. Enter the Path of the report you want to view in the 'source' property of the Property Editor. The data from your report will immediately load into the Report Viewer.
    Tip: You can right-click on any report in the designer Project Browser to Copy the full Path of the report.


  3. Parameters added during report creation are provided as properties in the Report Viewer. Add them under the 'params' object. (The example below uses the EndDate and StartDate parameters). The parameter names must match exactly to the parameters in your Report Resource, and will override any default values set in the Report Resource. 



  • No labels