The actuate.Viewer class retrieves and displays Actuate BIRT report contents in an HTML container. The actuate.Viewer class displays the report by page. The goto functions of this class change the current position and page displayed in the viewer.

Constructs a new viewer object. The container is an HTML object defined on the HTML page.

To assign the viewer to display in a <div id='containerName' /> tag on the page, use the following constructor call:

Table 7‑52 lists actuate.Viewer functions.

Disables the Interactive Viewer features of this viewer object. This is an asynchronous setting committed by submit( ).

To disable the Interactive Viewer option for myViewer, use code similar to the following:

Exports the report with a specified format. The downloadReport function does not return any object. The report is exported to the client side. Then the browser opens a download window for the user to specify a location for the report.

To download the first five pages of the report in the viewer, use the following code:

Gets all the data from the report as specified by the request. This function makes an AJAX call to the server for the data that is not in the current page. Write a callback function to process the result set. The callback must take an actuate.data.ResultSet object as an argument.

This example creates an actuate.data.ResultSet object from the report in myViewer as specified by myRequest and passes it to a callback function:

Enables interactive viewing features for this Viewer, which enables the selection and modification of report content. This function must be used in the callback of viewer.submit( ) as shown in the example below.

This function must be used in the callback of viewer.submit( ) as shown in the following example:

Returns an instance of the chart referenced by a bookmark.

actuate.report.Chart object.

This example returns the chart with the bookmark ChartBookmark:

Gets the browser window’s height.

Integer. Height in pixels.

To reset the viewer height to 20 pixels less than the browser window if it is larger than the browser window, use code similar to the following:

Gets the browser window’s width.

Integer. Width in pixels.

To reset the viewer width to 20 pixels less than the browser window if it is larger than the browser window, use code similar to the following:

Gets the report content by bookmark and passes the content as data to a callback.

To retrieve the content with the bookmark FirstChart as html, use code similar to the following:

Gets the report content by page range and passes the content as data to a callback.

To retrieve the content from pages 3 through 5 as html, use code similar to the following:

Gets the viewer content margin.

Integer or Object. An integer indicates the same margin on all sides, in pixels. The object contains the pixel values for the top, bottom, left, and right margins of the viewer in an array. For example, a 25-pixel top content margin and no margin in the other directions would be the object array {top:25, left:0, right:0, bottom:0}.

To set the margin of the viewer newViewer to match the margin of myViewer, use code similar to the following:

Returns the report content displayed in the viewer. This function is the entry point for retrieving the report elements from this viewer object.

actuate.viewer.PageContent object.

Use this function to access the bookmarks for specific elements in the page content. For example, to access the table "mytable" on the page loaded in the myViewer viewer object, use the following code:

Returns the page number for the page currently being displayed.

Integer. The current page number.

This function is useful to move to another page relative to the current page. To go to the next page in a document, use the following code:

Returns an instance of the Custom Visualization object referenced by a bookmark.

String. The bookmark name.

Returns an instance of a Custom Visualization object.

To get a new customViz object with a bookmark, use code similar to the following:

Returns an instance of report data referenced by a bookmark.

actuate.report.DataItem object.

To get the report data with the bookmark FirstDataItem and store it in the variable myDataItem, use code similar to the following:

Returns an instance of the Flash object referenced by a bookmark.

actuate.report.FlashObject object.

To get the Flash object with the bookmark FirstFlashObject and store it in the variable myFlashObject, use code similar to the following:

Returns an instance of the gadget referenced by a bookmark.

actuate.report.Gadget object.

To get the gadget with the bookmark FirstGadget and store it in the variable myGadget, use code similar to the following:

Returns the height value of the viewer.

String.

This example decreases the viewer’s height by 10:

Returns an instance of the label referenced by a bookmark.

actuate.report.Label object.

To get the label with the bookmark FirstLabel and store it in the variable myLabel, use code similar to the following:

Returns the bookmark of the current report page or element.

String. Bookmark.

This example displays the bookmark of the current report page in an alert box:

Returns the name of the report file, either a report design file or report document file, that is currently displayed in this Viewer.

String.

This example displays the currently displayed report file name in an alert box:

Returns an instance of the table referenced by a bookmark.

actuate.report.Table object.

To get the table with the bookmark FirstTable and store it in the variable myTable, use code similar to the following:

Returns an instance of the Text object referenced by a bookmark.

actuate.report.Text object.

To get the Text object with the bookmark Title and store it in the variable myText, use code similar to the following:

Returns the total number of pages in the report being viewed.

Integer.

This function is useful to move to the last page of a document. To go to the last page in a document, use the following code:

Returns the current UI configuration.

actuate.viewer.UIConfig object. This function returns null when no UIConfig object is set.

To retrieve and store the content pane from the viewer, use the following code:

Returns the UIOptions set in this viewer object.

actuate.viewer.UIOptions object. This function returns null when no UIOptions object is set.

To retrieve and store the uiOptions for the viewer, use the following code:

Returns a viewer object containing the report element that is associated with a bookmark or contained in an HTML element.

actuate.Viewer object or null if the viewer is not found.

This example uses getViewer( ) to retrieve a report element and return the bookmark of the chart in that report:

Returns the width value of the viewer.

String.

This example decreases the viewer’s width by 10:

Goes to the page position by the specified bookmark. The viewer displays to the first page when the bookmark is not found.

To move the viewer to the page position specified by the value of the 'bookmark' parameter, use this code:

Goes to the specified page. The viewer throws an exception when the page is not found.

To go to the first page of a report, use the following code:

Returns the interactive viewing status of the viewer. Enables or disables the interactive viewing features with actuate.Viewer.enableIV( ).

Boolean. True when interactive viewing features are enabled.

This example displays an alert box with the interactive status of the viewer:

Saves the current viewer content as a report design. The viewer must enable interactive viewing with enableIV( ) prior to saving a report design.

To save the content of the viewer as the report design called NewDesign, use the following code:

Saves the current viewer content as a report document. The viewer must enable interactive viewing with enableIV( ) prior to saving a report design.

To save the content of the viewer as the report document called NewDocument, use the following code:

Sets the viewer content margin.

To set the internal margin of the viewer to a 10‑pixel buffer, use the following code:

Sets the focus for the viewer.

This example blurs the context menu for the viewer:

Sets the viewer height.

To set the height of the viewer to 600 pixels, use the following code:

Sets parameters for executing report using literal string pairs.

To set the value of a parameter, city, to the value, New York, use the following object literal:

Sets parameter values for executing a report using ParameterValue objects.

To set parameter values for a report to the values in the pvs array, use this code:

Sets the report document to render in this Viewer.

To open the Top Sales Performers report, set the report by name and then call submit( ), as shown in the following example:

Sets the bookmark for the Reportlet rendered.

To open the Top_5_Customers Reportlet of the Customer Sales Dashboard, set the Reportlet bookmark by name and then call viewer.submit, as shown in the following example:

Sets the report file, either a report design or report document, to render in this Viewer.

To open the Top Sales Performers report, set the report by name and then call submit( ), as shown in the following example:

Sets the target service URL to which this Viewer links. When the service URL is not set, this Viewer links to the default service URL, which is set on the actuate object.

This example sets the URL for the Actuate iPortal web application service:

Resizes the viewer’s width and height.

To set the viewer’s size to 300 pixels by 300 pixels, use code similar to the following:

Controls Scalable Vector Graphics support for the viewer.

To disable Scalable Vector Graphic support for the myViewer viewer, use code similar to the following:

Sets the UI options for the viewer using an actuate.viewer.UIOptions object.

To hide the toolbar for the viewer, use the following code:

Sets the dashboard viewing mode.

To display content without dashboard features, use the following code:

Sets the viewer width.

To set the width of the viewer to 800 pixels, use the following code:

Displays the export report dialog window.

Use this code to display the report dialog window:

Displays the export data dialog window.

Use this code to display the result set download dialog window:

Displays the Facebook comments panel.

Use this code to display the Facebook comments panel:

Displays the parameter panel.

Use this code to display the parameter panel:

Displays the print dialog window.

Use this code to display the print dialog window:

Displays the table of contents panel.

Use this code to display the table of contents panel:

Updates and reloads the viewer after submitting requests for the viewer. The submit( ) function triggers an AJAX request for all asynchronous operations. When the server finishes the processing, it returns a response and the results are rendered on the page in the viewer container. Calling submit( ) when a previous submit( ) is pending throws an exception.

To open the Top Sales Performers report, set the report by name and then call submit( ), as shown in the following example:

Sets the default user interface for the viewer.

Boolean. True defines the Interactive Viewer interface as a default interface. False disables the Interactive Viewer user interface from showing up.

Void

If this is set to false, you must implement your own user interface: