Update report settings at runtime
You can use the report.updateSettings
method to update the report settings when the report is already loaded.
The settings
property is used to adjust the appearance and behavior of your embedded Power BI report.
How to update the report settings
The Power BI Client Report class defines the updateSettings
method as:
report.updateSettings(settings: ISettings): Promise<IHttpPostMessageResponse<void>>
See Configure report settings for the settings object details.
Example
To update the report settings and show the bookmarks pane:
const newSettings = {
panes: {
bookmarks: {
visible: true
}
}
};
await report.updateSettings(newSettings);
Considerations and limitations
The following settings can't be updated after the report is loaded:
- Locale settings
- Mobile layout, if the report was initially loaded or bootstrapped without mobile layout
- Page navigation pane position