Page History

Versions Compared

Key

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

...

This API will only be available on pages that have the included the “JsAPI/v3” JS file into their page. See example:

<script src="https://pathToYourYellowfinServer/JsAPI/v3"></script>

Note
This API will not be available in Dashboard Code Mode.

...

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>
<div id="reportDiv"></div>
<script>
yellowfin.init().then(() => {
//The Yellowfin base API has now loaded. Now load a report
yellowfin.loadReport({
reportId: 'c83357db-8aef-4ec7-ab72-fce34de9ee77',
element: document.querySelector('div#reportDiv'),
});

});
</script>

logoff()

Returns

Nothing

Description

...

filterId - UUID or Name of the filter you wish to set.
valueOne - The first value of the filter.
valueTwo - The second value of the filter, only has an affect on Between and Not Between filter types.
valueList - Array of values to apply to a list filter.

[{ //Set a between filter
filterId: '1c1e0878-3bd6-402b-bad8-98202e6b8fb1',
valueOne: 15,
valueTwo: 35
}]

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.

If you do set this, it allows you to load multiple views of the same instance of the report.

//Load the report into two different elements
yellowfin.loadReport({
reportId:'9617ada1-28bc-42ef-9c3f-8b40d3d1ae61',
element: document.querySelector('div#firstReport'),
instanceName: 'firstReport'
});

yellowfin.loadReport({
reportId:'9617ada1-28bc-42ef-9c3f-8b40d3d1ae61',
element: document.querySelector('div#secondReport'),
instanceName: 'firstReport'
});

showToolbar

Type: Boolean

Determines whether or not to show the reports toolbar.

//Load the report with showToolbar not defined
yellowfin.loadReport({
reportId:'9617ada1-28bc-42ef-9c3f-8b40d3d1ae61',
element: document.querySelector('div#reportDiv');
});
//Load the report with showToolbar set to true
yellowfin.loadReport({
reportId: '9617ada1-28bc-42ef-9c3f-8b40d3d1ae61',
element: document.querySelector('div#reportDiv'),
showToolbar: true
});

Or set the showToolbar property to false:

//Load the report with showToolbar set to false
yellowfin.loadReport({
reportId: '9617ada1-28bc-42ef-9c3f-8b40d3d1ae61',
element: document.querySelector('div#reportDiv'),
showToolbar: false
});

showTitle

Type: Boolean

Determines whether or not to show the report title in the report’s toolbar. Default: true.

If the showTitle option is set to false:

//Load the report with showTitle option set to false
yellowfin.loadReport({
reportId: '9617ada1-28bc-42ef-9c3f-8b40d3d1ae61',
element: document.querySelector('div#reportDiv'),
showTitle: false
});

showInfo

Type: Boolean

Determines whether or not to show the info option in the report’s toolbar. Default: true

If this option is set to false:

//Load the report with showInfo option set to false
yellowfin.loadReport({
   reportId: '9617ada1-28bc-42ef-9c3f-8b40d3d1ae61',
   element: document.querySelector('div#reportDiv'),
   showInfo: false
});

showFilter

Type: Boolean

Determines whether or not to show the filters option in the reports toolbar. Default is true.

If this option is set to false:

//Load the report with showFilter option set to false
yellowfin.loadReport({
   reportId: '9617ada1-28bc-42ef-9c3f-8b40d3d1ae61',
   element: document.querySelector('div#reportDiv'),
   showFilter: 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.

With the showExport parameter set to false, the export icon in the toolbar will be removed:

//Load the report with showExport option set to false
yellowfin.loadReport({
   reportId: '9617ada1-28bc-42ef-9c3f-8b40d3d1ae61',
   element: document.querySelector('div#reportDiv'),
   showExport: 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
yellowfin.loadReport({
   reportId: '9617ada1-28bc-42ef-9c3f-8b40d3d1ae61',
   element: document.querySelector('div#reportDiv'),
   showShare: false
});

showDisplayToggle

Type: Boolean

...

If this option is set to false:

//Load the report with this option set to false
yellowfin.loadReport({
   reportId: '9617ada1-28bc-42ef-9c3f-8b40d3d1ae61',
   element: document.querySelector('div#reportDiv'),
   showReportDisplayToggle: false
});

Example

Load the report and then print its name:

yellowfin.loadReport({
reportId: aReportId,
element: elementToRenderTo
}).then(report => {

//Some code to execute when the report has loaded

console.log(report.name + ‘ has finished loading’);
});

Interactions

The interactions object enables you to define which interactions should be available on a particular visualization of a report. This lets you tell the Yellowfin renderer which functionality you want the user to be able to use within that visualization.

...

To disable all user interactivity on the report when using loadReport:

yellowfin.loadReport({

reportId: ‘a report id’,

interactions: {

drillDown: false,

drillAnywhere: false,

drillThrough: false,

unitSelection: false,

brushing: false,

timeSlider: false,

drillBreadcrumbs: false,

seriesSelection: false,

annotations: false

element: document.querySelector(‘#reportElement’)

}).