Page History
...
The Base API contains a number of functions to assist with loading the Yellowfin APIs in your own web page. There are functions to load the report and dashboard loader APIs which will allow you to load Dashboard and Reports.
There is also a function to assist with session management.
init()
Returns
Promise
Description
Initialises the Base API. This is called when the API is included into a page. Returns a promise to indicate when this has finished loading, any usage of the API should wait until this promise has resolved.
Example
Include the Yellowfin Report API on the page and then load a report after the init() promise has resolved:
<script src="https://pathToYourYellowfinServer/JsAPI/v3"></script> |
logoff()
Returns
Nothing
Description
Ends the current user session.
loadReport(reportOptions)
Returns
Promise
Description
Waits for the init() promise to load and then loads a report with the passed options. Once the report has been loaded it will be appended to the passed element and the report will begin to run.
When the promise is resolved a Report object will be passed to the .then() functions. The promise will be resolved just before the report starts running.
...
There are a number of options that will be accepted as part of the options object:
reportId
...
(required)
Type: String
ReportUUID of the report we wish to load. This is the PublishUUID on the ReportHeader table.
element
...
(required)
Type: DOM Element, Selector String
...
If no width or height is passed the report will expand to the dimensions of the element.
width
Type: Number
Width to render the report in pixels.
height
Type: Number
Height to render the report in pixels.
filterValues
Type: Array[Object]
Array of Objects that will be used to apply the initial filter values.
...
[{ //Set a between filter |
instanceName
Type: String
Identifier for this instance of the report. If this property is not defined, a random id will be generated. This means that if you include the same report multiple times without defining an instance name, it will always be a separate instance of that report.
...
//Load the report into two different elements |
showToolbar
Type: Boolean
Determines whether or not to show the reports toolbar.
...
//Load the report with showToolbar set to false |
showTitle
Type: Boolean
Determines whether or not to show the report title in the report’s toolbar. Default: true.
...
//Load the report with showTitle option set to false |
showInfo
Type: Boolean
Determines whether or not to show the info option in the report’s toolbar. Default: true
...
//Load the report with showInfo option set to false |
showFilter
Type: Boolean
Determines whether or not to show the filters option in the reports toolbar. Default is true.
...
//Load the report with showFilter option set to false |
showExport
Type: Boolean
Determine whether or not the export option will be displayed in the report toolbar. Export options allow a report to be exported to an external file format such as csv, xls, pdf, txt and doc.
...
//Load the report with showExport option set to false |
showShare
Type: Boolean
Determines whether or not to show the share option in the reports toolbar. Default is true.
//Load the report with showShare option set to false |
showDisplayToggle
Type: Boolean
Determines whether or not to show the reports chart/table options in the reports toolbar. Default is true.
...
yellowfin.loadReport({ //Some code to execute when the report has loaded console.log(report.name + ‘ has finished loading’); |
loadDashboard(dashboardOptions)
Returns
Promise
Description
Waits for the init() promise to load and then loads a dashboard with the passed options. Once the dashboard has been loaded it will be appended to the passed element and the content on the dashboard will begin to run.
There are a number of parameters that can be included in the dashboardOptions object:
dashboardUUID
...
(required)
Type: String
The PublishUUID of the dashboard that you wish to load.
...
element (required)
Type: DOM Element, Selector String
...
If no width or height is passed the dashboard will fill the dimensions of the element.
filterValues
Type: Array[Object]
Array of Objects that will be used to apply the dashboards initial filter values.
...
[{ //Set a between filter |
showToolbar
Type: Boolean
Determines whether or not to show the dashboard’s toolbar. Default is true.
...
//Load the dashboard with showToolbar set to false |
showInfo
Type: Boolean
Determines whether or not to show the info option in the dashboard’s toolbar. Default: true.
...
//Load the dashboard with showInfo option set to false |
showShare
Type: Boolean
Determines whether or not to display the share option in the dashboard’s toolbar. Default is true.
...
//Load the dashboard with showShare option set to false |
showFilters
Type: Boolean
Determines whether or not to show the filters option in the dashboard’s toolbar. Default is true.
...
//Load the dashboard with showFilter option set to false |
scaleCanvasTabs
Type: Boolean
Determines whether or not a canvas tab should be scaled. Default is true.
...
//Load the dashboard with scaleCanvasTabs option set to false |
showGlobalContentContainer
Determines whether or not to show the global content containers when rendering the dashboard.
...