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

Dashboard Widget

Dashboard Widgets are used to define the contents of each page in order to produce a dashboard. The dashboard will hold all other widgets to be displayed, called, or used on a page. It can contain as many reports as required, each styled be its own CSS class, as well as allowing for styles to be applied to the dashboard as a whole.

Dashboards can contain the following widgets:

Each dashboard is reference directly by a URL, and this is how navigation between pages is performed. Navigation links can be provided via the use of header or left side navigation panels, depending on design and user requirements.

Each dashboard can contain filters for sharing between widgets. Filter widgets allow the values of filters to be defined in the XML, or set via the user upon viewing the dashboard. Reports that have been linked to these filters will automatically refresh when a user changes filter values.

Dashboards are standalone entities. Nothing, including filters and hidden reports, can be shared between dashboards. However, should the dashboard designer wish to share content across dashboards, this can be achieved through the use of Sub Tab widgets. In this scenario, each dashboard would in fact be created as a sub tab within a main dashboard holder, with styling to make each sub tab appear separate.


Sub Tab Widget

Sub Tab Widgets are used for toggling between different sections of content, within a single dashboard definition - much like how sub tabs work within the standard Yellowfin interface. A button or drop down list allows the user to switch between tabs to display different content on the screen. 

Sub tab button options can contain four different elements; Title, Description, Icon, and Summary Value. The text and icon are defined through the XML, but the summary value is sourced directly from a Yellowfin report.

When using summary information, if a particular option has no results, that sub tab can be hidden. This allows for sub tabs to be displayed (or hidden) on a per-user basis, or based on the results of other filters on the page.

Sub tabs can contain the following widgets:


Sample Report

Summary information is source from a hidden report, which may be designed like this:

Booking Stats65
Ski Camps12

Sample Output

With the resulting sub tab options displayed like this:


Text Widget

Text Widgets are used to display basic static text, which may include headings, descriptions, and captions. More advanced text, such as linked text or a combination of static and report data text, can be achieved using the Custom HTML Widget.


Export Button Widget

Export Widgets are used to display a link or button which allows users to generate an export of the dashboard or a report to PDF, XLS, or Print Dialogue. 

    • PDF - exports the viewed dashboard sub tab, in its current state, with the option of using custom CSS for styling of the output.
    • XLS - exports an individual report, defined in the XML.
    • Print - opens the browser print dialogue, enabling the user to print the viewed dashboard sub tab in its current state.


Filter Widget

Filter Widgets provide a user interface element that feeds values to filters use by Report Widgets. The filters can be configured to display as buttons, drop down lists, and calendar date pickers. Changing the values selected in these filters will automatically cause any reports using these values to be refreshed on the dashboard display. 

Filters can be customised, using combinations of text labels, descriptions, and icons. Filter values can be defined through the XML, or set up so that the user is required to set the values when viewing the dashboard.

Filters can be used with text, numeric, and date values. When defining options for a date filter, special tokens can be used to create filters based on the current date. This allows filters to use date ranges such as year to date, month to date, rolling year, and previous year. A custom date picker can also be used when selecting custom user prompt dates.

An option can be specified so that a filter value is attached to a user's session. Any filters with the same name on other dashboards will then inherit the values previously entered. This allows for a date filter on a dashboard to be automatically populated with the values entered on previously visited tabs.

Possible filter displays include; top navigation filters (see the date filters above), drop down lists, and filter buttons with optional summary information in the same way sub tab options are formatted.


Report Widget

Report Widgets are used to include a chart, multi-chart, or tabular report results from Yellowfin on a dashboard. These results can be displayed on the dashboard, or hidden for use by other linked widgets. Linked widgets may include Filter, Tab, Modal Windows, and Custom HTML.

A report can be formatted in several ways, including; chart, table, map, or hidden.





Modal Window Widget

Modal Window Widgets are used to display a child (popup) window over a dashboard that contains content. A modal can be attached to a link or button on a report. The modal can be used in a "Show All" capacity - display full report results in the popup window, rather than capped ones on the dashboard. Alternatively, it can be used to create a drill through link to style relationship (built purely in DashXML, not the Yellowfin interface), displaying a child report.


Custom HTML Widget

Custom HTML Widgets act as containers which allow for the design of customised functionality defined by HTML and/or JavaScript. Report and filter data can be passed into this widget for use within the custom design.


  • No labels