About the BIRT Interactive Crosstabs JavaScript API
The Interactive Crosstabs portion of the Actuate JavaScript API is a set of JavaScript classes that modify, analyze, and display data within cross tab elements. These classes are available to users of iHub Visualization Platform client. The Actuate JavaScript API functions that are described in this chapter invoke and control the Interactive Crosstabs viewer and elements that are associated with the viewer. The Interactive Crosstabs JavaScript can be placed within a web page or any other location where the Actuate JavaScript API interfaces with a cross tab.
The actuate.xtabAnalyzer class represents the Interactive Crosstabs viewer that contains cross tab information. Load the analyzer with actuate.load( ).
Load the XTabAnalyzer component to prepare the actuate.XTabAnalyzer component for use in a web page. Call actuate.XTabAnalyzer functions to create and prepare an analytics cross tab. Call the XTabAnalyzer submit( ) function to display an existing cross tab in a specified HTML <div> element on a web page.
The following JavaScript code creates an Interactive Crosstabs viewer instance:
var ctViewer = new actuate.XTabAnalyzer("cTab");
In this example, cTab is the name value for the <div> element that holds the cross tab content. The web page body must contain a <div> element with an ID value of cTab, as shown in the following code:
<DIV ID="cTab"></DIV>
When no <div> element with the correct ID value exists in the web page body, the Interactive Crosstabs viewer launches in a pop-up window.
To load a cross tab or a data cube, use setReportName( ):
The example code loads a report document, MyXtabSummary.rptdocument located in the user’s home folder, that consists of a single data cube and cross tab. The report document can be loaded into the Interactive Crosstabs viewer directly.
To access a cross tab element that is part of a larger report, use the cross tab element’s bookmark after setting the report name. A bookmark is set in a report designer or by an external function. Retrieve a cross tab element with actuate.xtabanalyzer.PageContent.getCrosstabByBookmark( ). For example, the following code retrieves a cross tab with the bookmark SampleRevenue:
var content = ctViewer.getCurrentPageContent( );
var crosstab = content.getCrosstabByBookmark("SampleRevenue");
The code in this example retrieves the current page content and the cross tab element within that page, returning an actuate.xtabanalyzer.Crosstab object. This cross tab object supports the modification of the cross tab with the functions in the XTabAnalyzer subclasses.
To set the bookmark for a cross tab element, create a bookmark for the element within BIRT Designer Professional or call setXTabBookmark( ), as shown in the following code:
This example code assigns the bookmark SampleRevenue to the cross tab.
The XTabAnalyzer.submit( ) function triggers an AJAX request to display the report with all the asynchronous operations that previous viewer functions have prepared. Call submit( ) as shown in the following code:
ctViewer.submit( );
Upon executing submit( ), the Actuate web application returns the report with the cross tab in the assigned <div> element.