os.powerBiReport

Object that allows you to interact with a Power BI report.

Allows you to configure the report's parameters and rendering at runtime.

Syntax

Copy 
os.powerBIReport(id: string)
 
Parameter Type Description
id string ID of the Power BI report as defined in the form's HTML markup. For example:
 
Copy
<os-powerbi-report id="myReport" ...>
...
</os-powerbi-report>
 

Methods

Method Description
fullscreen() Sets the report to run in full screen mode.
setReportParameters(data: any) Sets values for specific report parameters.
IMPORTANT!  
Setting the value of a context-bound parameter to a constant will remove the binding and the parameter will not react to further changes of the context property.
Optionset parameters can be set using the optionset item ID or the optionset item name. The value passed to the Power BI service will be the name.

Examples

In this example:

  • We set the myReport Power BI report to run in full screen mode.
  • We set values for the pStatus and pIsExpired parameters of the report.
Copy 
os.powerBIReport("myReport").fullscreen();
os.powerBIReport("myReport").setParameters(
    { 
        pStatus : 'Expired',
        pIsExpired : true
    });