Like what you see? Have a play with our trial version.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
top
top

Note

As of Yellowfin version 9.2, JavaScript API v3 has been released. This API supersedes and replaces the existing v2 API. Until otherwise advised, the Version 2 API will continue to be supported but will not be enhanced. Information on this v3 API can be found here.


Table of Contents
classcontents

Overview


Styleclass
ClasstopLink

37061386top

Using the JavaScript API version 2, Yellowfin Reports and Dashboards can be embedded into external webpages, which can be hosted on a separate web server to Yellowfin. The only requirement is that the end user's browser be able to access the Yellowfin server. This is achieved by placing a scriptlet into the HTML code. The following example shows what a JavaScript scriptlet looks like:

...

Interactive elements such as Drill Through, Drill Down, User Prompt Filters, Series Selection, and Export to PDF are available.

Display

...

ClasstopLink

...


Report

The embedded report contains a Title Bar and the Report itself. The Title Bar contains the name of the report, as well as buttons to control any interactive elements used on the report. The interactive features include:

...


Description

Displays basic Dashboard Information including; Name, Description, Last Modified Date, and Current User

Displays the Javascript used to embed the dashboard

Opens a panel of User Prompt Filters enabled on the dashboard

Opens the Export panel, allowing the user to export the dashboard to various formats, including:

  • Export to CSV
  • Export to DOC
  • Export to PDF
  • Export to Rich Text Format
  • Export to XLS

Example Usage

...

...

ClasstopLink

...

37061386


Embedding a Report

Using the Share menu, copy the Embed JavaScript, which identifies the report to load, for use in your HTML page, wiki, or blog. It will take a form similar to this:

...

Anchor
userAccess
userAccess

User Access

...

...

37061386

Users are authenticated when accessing a report or dashboard through the Javascript API. If a user has not yet logged in, they may be able to view the content as a Guest user. (Click here to learn how to do this.) There are a number of factors used to determine whether a report or dashboard can be run as a Guest user, or whether unauthenticated users are required to log in.

...

Anchor
limitations
limitations

Limitations

...

...

37061386

The current limitations of the Javascript API include:

...

horizontalrule

Styleclass
ClasstopLink

37061386top