You're currently browsing the Ignition 8.0 docs. Click here to view the latest docs.

The following feature is new in Ignition version 8.0.10
Click here to check out the other new features

Component Palette Icon:


IULocgo


Report Viewer

Description

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. The Report Viewer is found at the bottom of the Perspective Component palette in the Designer. 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.

The Report Viewer is also mobile-friendly and has a responsive design as its size is modified to fit smaller screens. 

To learn more, refer to Reporting in Perspective.

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. New Reports have default "StartDate" and "EndDate" properties.

NameDescriptionProperty Type
EndDateEnd date for the report.value: date
StartDateStart date for the report.value: date
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
allowDownloadIf 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.value: boolean
allowOpenInTabIf 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.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


PropertyValue
sourceStatus Report

params:

   EndDate
   StartDate


2020-02-24 16:00:00
2020-02-24 14:00:00

page3
pageCount6
zoomLevel100
backgroundColor#AC0000


  • No labels