Page History
...
| Table of Contents | ||
|---|---|---|
|
Overview
| Styleclass | ||
|---|---|---|
| ||
Using the JavaScript API, 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
| Styleclass | ||
|---|---|---|
| ||
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 Report Information including; Name, Description, Last Modified Date, Category, Sub Category, and Current User |
| Displays the JavaScript used to embed the report |
| Allows the user to toggle to Chart view if Table and Chart display is used |
| Allows the user to toggle to Table view if Table and Chart display is used |
| Opens a panel of User Prompt Filters enabled on the report |
| Opens a Series Selection panel if the Visible Series Selection option is enabled |
| Opens a Unit Selection panel if the Visible Units Selection option is enabled |
| Opens a Page Navigation panel if the report contains multiple pages |
| Opens a Section Navigation panel if the report contains sections |
| Opens the GIS Map Navigation panel if the map has Hover Navigation enabled |
| Opens the Export panel, allowing the user to export the report to various formats, including:
|
Dashboard
The embedded dashboard contains a Title Bar for the entire dashboard, and then each of the dashboard reports (displayed the same as embedded reports), laid out the same way as they are when viewed through the Yellowfin front end.
Note: dashboard filters and KPI dashboards are supported.
| 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:
|
Example Usage
| Styleclass | ||
|---|---|---|
| ||
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:
...
See the Basic Use for more information.
Embedding a Dashboard
Using the Distribute menu, copy the Embed Javascript, which identifies the dashboard to load, for use in your HTML page, wiki, or blog. It will take a form similar to this:
...
| Anchor | ||||
|---|---|---|---|---|
|
User Access
| Styleclass | ||
|---|---|---|
| ||
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
| Styleclass | ||
|---|---|---|
| ||
The current limitations of the Javascript API include:
...
| horizontalrule |
|---|
| Styleclass | ||
|---|---|---|
| ||