Jump to content
Changes to the Jaspersoft community edition download ×
  • This documentation is an older version of JasperReports Server Visualize.js Guide. View the latest documentation.

    The dashboard function runs dashboards on JasperReports Server and displays the result in a container that you provide. Dashboards are a collection of reports and widgets that you design on the server. Dashboards were entirely redesigned in JasperReports Server 6.0 to provide stunning data displays and seamless integration through Visualize.js.

    This chapter contains the following sections:

    Dashboard Properties
    Dashboard Functions
    Dashboard Structure
    Rendering a Dashboard
    Getting the Embed Code of a Dashboard
    Refreshing a Dashboard
    Tracking Completion Status
    Using Dashboard Input Controls
    Using the Dashboard Undo Stack
    Setting Dashboard Hyperlink Options
    Exporting From a Dashboard
    Closing a Dashboard

    Dashboard Properties

    The properties structure passed to the dashboard function is defined as follows:

    Dashboard Functions

    The dashboard module exposes the following functions:

    Dashboard Structure

    The Dashboard Data structure represents the rendered dashboard object manipulated by the dashboard function. Even though it's named "data," it does not contain any data in the dashboard or reports, but rather data about the dashboard. For example, the Dashboard Data structure contains information about the items in the dashboard, called dashlets.

    Rendering a Dashboard

    To run a dashboard on the server and render it in Visualize.js, create a dashboard object and set its properties. Like rendering a report, the resource property determines which dashboard to run, and the container property determines where it appears on your page.

    The following code example shows how to define a dashboard ahead of time, then render it at a later time.

    Getting the Embed Code of a Dashboard

    As of JasperReports Server 7.9, the server can provide the code to embed any dashboard displayed in the Dashboard Designer. This lets you browse the repository, preview the dashboard, and get its basic embed code. You can paste this code directly in your application, and then edit it for your needs. You can also open the dashboard's embed code in JSFiddle to see the effect of your edits in real time, then copy the final code from JSFiddle.

    To copy the embed code of a dashboard:

    1. Log into JasperReports Server and browse the repository to find the dashboard you want to embed.
    2. View the dashboard so that it is displayed in the server's Dashboard Designer.
    3. Click the js-Viewer-icon-EmbedCode.png.25ed5444363e8a29f14c0dcecc681d98.png
    4. The Dashboard Embed Code dialog shows you the Visualize.js code and a preview of the dashboard as it is currently saved. Select Copy Code to copy the entire code block to your clipboard. You can also highlight selected parts of the code and use Ctrl-C (Command-C on Mac OS), for example if you want only the main function.

    The Embed Code of a Dashboard

    js-Dashboard-GetEmbedCode.png.a2570cdca59a46aa769544e5b4eea8be.png

    The code sample includes comments where you can enter credentials for authentication. You should also change the name of the container to match the one in your application.

    5. Alternatively, select Open in JSFiddle to load the same code into a new Fiddle, an online JavaScript viewer and interactive editor. This lets you modify the JavaScript or HTML, and add CSS if desired, then see the results in real time.

    If you have write permission to the dashboard, you can switch to editing mode and still get the embed code at any time. Regardless of when you get the embed code, Visualize.js always displays the latest saved version of a dashboard, as determined by the repository URL in the embed code.

    When displayed through Visualize.js, the elements of a dashboard, called dashlets, include the vz-icon-ChartSelector.png.78e1988733602c4108123ff52725957c.png icon that allows users to switch between table, crosstab, and chart type, though not all chart types work with the data in a given dashlet. This selector changes the appearance of the dashlet in the user's current session, but the changes can't be saved. For every new session, Visualize.js displays the default appearance of the entire dashboard.

    Refreshing a Dashboard

    You can order the refresh or re-render of the dashboard, as well as cancel the refresh if necessary, for example if it takes too long.

    Tracking Completion Status

    By listening for the dashboardCompleted event, you can give information or take action when a dashboard finishes rendering.

    Using Dashboard Input Controls

    Like reports, dashboard can have input controls, also called filters, to change the values of what is displayed.

    Visualize.js dashboard input controls are rendered directly by the server. If a dashboard includes input controls, the dashboard is rendered with a small panel of corresponding UI widgets. When you embed the dashboard, it contains the interface that allows users to set input controls.

    You can also set input controls programmatically; for example you might update a dashboard based on other events in your web application. Input controls are called parameters within Visualize.js dashboards. To set input controls programmatically, you must first discover the list of available parameters:

    Then you read their values, modify them, and set new values. The dashboard then renders with the new input parameter values:

    Parameters are always sent as arrays of quoted string values, even if there is only one value, such as ["USA"]. This is also the case even for single value input such as numerical, boolean, or date/time inputs. You must also use the array syntax for single-select values as well as multi-select parameters with only one selection. No matter what the type of input, always set its value to an array of quoted strings.

    The following values have special meanings:

    "" – An empty string, a valid value for text input and some selectors.
    "~NULL~" – Indicates a NULL value (absence of any value), and matches a field that has a NULL value, for example if it has never been initialized.
    "~NOTHING~" – Indicates the lack of a selection. The meaning depends on the type of parameter:
         In multi-select parameters, this is equivalent to indicating that nothing is deselected, thus all are selected.
         In a single-select non-mandatory parameter, this corresponds to no selection (displayed as ---).
         In a single-select mandatory parameter, the lack of selection makes it revert to its default value.

    In the following example, a button resets the parameters to their default values by sending an empty parameter set (params({})). First the HTML to define the container and the button:

    And then the JavaScript to perform the action:

    In another example, the script initializes the parameters and the HTML displays a button when they're ready to be applied:

    And then the JavaScript to initialize the parameters and enable the button for the user:

    You can create any number of user interfaces, database lookups, or your own calculations to provide the values of parameters. Your parameters could be based on 3rd party API calls that get triggered from other parts of the page or other pages in your app. When your dashboards can respond to dynamic events, they become truly embedded and much more relevant to the user.

    Using the Dashboard Undo Stack

    Visualize.js dashboards provide undo and redo functionality. After users interact with input controls and modify the data on the dashboard, they may want to return to their initial dashboard state. With the undo and redo events and actions, you can allow your users to navigate their data more easily in dashboards.

    Visualize.js dashboards support the following actions:

    Undo – Reverts the input controls to next older set of values and updates the dashboard contents accordingly; available after at least one change to input controls.
    Redo – Reverts the input controls to next newer set of values and updates the dashboard contents accordingly; available after at least one undo action.
    Undo All – Reverts the input controls to their initial set of values and updates the dashboard contents accordingly; available when there is an older set of values that hasn't been undone.

    In order to implement undo and redo actions, you must also use event listeners to know when undo and redo events become available. For example, before the user has made any changes to input controls, no actions are possible. Redo is only possible after the user performs an undo or undo-all action.

    In the following example, the HTML has a table to display the input control values and buttons to perform the undo and redo actions:

    The CSS sets the size of the container to be large enough for a dashboard, and sets the table heading color for visibility:

    The JavaScript has listeners for the canUndo and canRedo events in order to set the visibility of the undo and redo buttons. When the buttons are enabled and the user clicks on one, the code takes the corresponding action then displays the ids and values of the input controls in the table. By combining the event listeners and actions, the page allows the user to step backward and forward through various sets of input controls in the dashboard.

     

    Setting Dashboard Hyperlink Options

    Visualize.js provides several types of hyperlinks to handle most use cases:

    Reference – The reference link indicates an external source that is identified by a normal URL. The only expression required is the hyperlink reference expression. It's possible to specify additional parameters for this hyperlink type.
    LocalAnchor – To point to a local anchor means to create a link between two locations into the same document. It can be used, for example, to link the titles of a summary to the chapters to which they refer. To define the local anchor, it is necessary to specify a hyperlink anchor expression, which will have to produce a valid anchor name. It's possible to specify additional parameters for this hyperlink type.
    LocalPage – If instead of pointing to an anchor you want to point to a specific current report page, you need to create a LocalPage link. In this case, it is necessary to specify the page number you are pointing to by means of a hyperlink page expression (the expression has to return an Integer object). It's possible to specify additional parameters for this hyperlink type.
    RemoteAnchor – If you want to point to a particular anchor that resides in an external document, you use the RemoteAnchor link. In this case, the URL of the external file pointed to will have to be specified in the Hyperlink Reference Expression field, and the name of the anchor will have to be specified in the Hyperlink Anchor Expression field. It's possible to specify additional parameters for this hyperlink type.
    RemotePage – This link allows you to point to a particular page of an external document. Similarly, in this case the URL of the external file pointed to, will have to be specified in the Hyperlink Reference Expression field, and the page number will have to be specified by means of the hyperlink page expression. Some export formats have no support for hypertext links. It's possible to specify additional parameters for this hyperlink type.
    ReportExecution – This type of hyperlink is used to implement drill-down. Page and anchor can be specified for the hyperlink type as well as additional special parameters such as _report, _anchor, _page, _output.
    AdHocExecution – This type of hyperlink represents an information about clicked point on chart reports generated from AdHoc Charts. It exposes names of measures and values of dimensions as parameters.
    Custom Hyperlink Type – A type of hyperlink that you can define entirely.

    And there are several types of link targets:

    Self – This is the default setting. It opens the link in the current window.
    Blank – Opens the target in a new window. Used for output formats such as HTML and PDF
    Top – Opens the target in the current window but outside any frames. Used for output formats such as HTML and PDF.
    Parent – Opens the target in the parent window (if available). Used for output formats such as HTML and PDF.
    Frame name – Always opens the target in the specified frame.

    The following table shows the new default action for each combination of link and target:

    Type Targets Self Blank Top Parent

    Reference

    (points to an external resource)

    Referenced URL is opened in an iframe on top of the report. Referenced url is opened in new tab. Referenced url is opened in same window. Referenced url is opened in parent frame for reports generated from AdHoc Charts.

    ReportExecution

    (points to JasperReports report)

    Referenced report is opened in same place through Viz.js (if hyperlink points to the same report, it's just gets updated with params/page/anchor). Referenced report is opened in new tab. Referenced report is opened in top frame (same window). Referenced report is opened in parent frame.

    LocalAnchor

    (points to an anchor in current report)

    Anchor is opened in same place through Viz.js. Referenced report anchor is opened in new browser tab. Referenced report anchor is opened in top frame (same window). Referenced report anchor is opened in parent frame.

    LocalPage

    (points to a page in current report)

    Page is opened in same place through Viz.js. Referenced report page is opened in new browser tab. Referenced report page is opened in top frame (same window). Referenced report page is opened in parent frame.

    RemoteAnchor

    (points to an anchor in remote document)

    Since remote anchor could be a link to resources like PDF or HTML, we have to open it in an iframe on top of the report. Referenced report anchor is opened in new browser tab. Referenced report anchor is opened in top frame (same window). Referenced report anchor is opened in parent frame.

    RemotePage

    (points to a page in remote document)

    Since remote page could be a link to resources like PDF or HTML we have to open it in an iframe on top of the report. Referenced report page is opened in new browser tab. Referenced report page is opened in top frame (same window). Referenced report page is opened in parent frame.

    AdHocExecution

    The hyperlink provides parameters, which are exposed to Filter Manager for additional wiring (beyond the scope of this document).

    The following code samples demonstrate the default handling of hyperlinks and the effect of defining overrides that remove the default handling. First the HTML for some buttons:

    And now some hyperlink overrides:

    However, if your dashboards are designed for custom drill-down, you can still define custom link handling so your users can access more reports and more data. Be sure to modify your code to handle all three function parameters for function(ev, link, default), as shown in this updated code sample:

    Exporting From a Dashboard

    Like a report, you can export a dashboard by invoking its export function and specifying the outputFormat and detailed property. You must wait until the dashboard's run action has completed and returns success before starting the export. The following export types and formats are supported:

    Screenshot: "pdf", "png", "docx", "pptx", "odt"
    Detailed: "pdf", "xlsx" "csv", "docx", "rtf" "odt" "ods" " Excel" "pptx"

    In the following examples, the HTML page has a container for the dashboard and a button for the export, and the CSS configures a simple loading animation:

    CSS:

    The detailed property determines the export type. You can define the detailed property as follows:

    For the detailed export type - detailed: true
    For the screenshot export type - detailed: false

    The default value is false. If you do not provide any value for the detailed property, it is considered false (default) and the dashboard gets exported as a screenshot.

    In the first JavaScript example below, the button exports the PDF of the dashboard in the detailed export type, however the button is disabled until the dashboard has finished running and returned success. When the button is enabled and clicked, the export function is called with the "pdf" format in the detailed export type. When the export is ready, the PDF file is made available to download in the browser.

    Visualize.js also exposes the list of available export formats. The following example uses this list to build a drop-down selector of export formats, and the chosen format is passed to the export function when the Export button is clicked.

    To get the list of all supported export formats, use the following functions:

    For the detailed export type: v.dashboard.detailedExportFormats
    For the screenshot export type: v.dashboard.exportFormats

    This example uses the function for the screenshot export type. This example uses the same HTML and CSS code shown above.

    Closing a Dashboard

    When you want to reuse a container for other contents and free the dashboard resources, use the destroy function to close it.


    User Feedback

    Recommended Comments

    There are no comments to display.



    Guest
    This is now closed for further comments

×
×
  • Create New...