Report class

bookmarksManager: BookmarksManager

Property Value

Add context menu extension command.

report.addContextMenuCommand(commandName, commandTitle, contextMenuTitle, menuLocation, visualName, visualType, groupName)
 .catch(error => {
     ...
 });

function addContextMenuCommand(commandName: string, commandTitle: string, contextMenuTitle: string, menuLocation: MenuLocation, visualName: string, visualType: string, groupName?: string): Promise<IHttpPostMessageResponse<void>>

Parameters

Returns

Add options menu extension command.

report.addOptionsMenuCommand(commandName, commandTitle, optionsMenuTitle, menuLocation, visualName, visualType, groupName, commandIcon)
 .catch(error => {
     ...
 });

function addOptionsMenuCommand(commandName: string, commandTitle: string, optionsMenuTitle?: string, menuLocation?: MenuLocation, visualName?: string, visualType?: string, groupName?: string, commandIcon?: string): Promise<IHttpPostMessageResponse<void>>

Parameters

Returns

Add an empty page to the report

// Add a page to the report with "Sales" as the page display name
report.addPage("Sales");

function addPage(displayName?: string): Promise<Page>

Parameters

Returns

Apply a theme to the report

report.applyTheme(theme);

function applyTheme(theme: IReportTheme): Promise<void>

Parameters

Returns

Returns if there are user's filters, slicers, or other data view changes applied on the report. If persistent filters is disable, returns false.

report.arePersistentFiltersApplied();

function arePersistentFiltersApplied(): Promise<boolean>

Returns

Clears selected not popped out visuals, if flag is passed, all visuals selections will be cleared.

report.clearSelectedVisuals()
 .then(() => {
     ...
 });

function clearSelectedVisuals(clearPopOutState?: boolean): Promise<void>

Parameters

Returns

Closes all open context menus and tooltips.

report.closeAllOverlays()
 .then(() => {
     ...
 });

function closeAllOverlays(): Promise<void>

Returns

Handle config changes.

function configChanged(isBootstrap: boolean)

Parameters

Delete a page from a report

// Delete a page from a report by pageName (PageName is different than the display name and can be acquired from the getPages API)
report.deletePage("ReportSection145");

function deletePage(pageName: string): Promise<void>

Parameters

Returns

Gets the active report page.

report.getActivePage()
 .then(activePage => {
     ...
 });

function getActivePage(): Promise<Page>

Returns

Gets filters that are applied at the report level.

// Get filters applied at report level
report.getFilters()
  .then(filters => {
    ...
  });

function getFilters(): Promise<IFilter[]>

Returns

Gets the report ID from the first available location: options, attribute, embed url.

function getId(): string

Returns

Gets a report page by its name.

report.getPageByName(pageName)
 .then(page => {
     ...
 });

function getPageByName(pageName: string): Promise<Page>

Parameters

Returns

Gets the list of pages within the report.

report.getPages()
 .then(pages => {
     ...
 });

function getPages(): Promise<Page[]>

Returns

get the theme of the report

report.getTheme();

function getTheme(): Promise<IReportTheme>

Returns

Return the current zoom level of the report.

function getZoom(): Promise<number>

Returns

checks if the report is saved.

report.isSaved()

function isSaved(): Promise<boolean>

Returns

Updates the position of a visual in a page.

report.moveVisual(pageName, visualName, x, y, z)
  .catch(error => { ... });

function moveVisual(pageName: string, visualName: string, x: number, y: number, z?: number): Promise<IHttpPostMessageResponse<void>>

Parameters

Returns

Prints the active page of the report by invoking window.print() on the embed iframe component.

function print(): Promise<void>

Returns

Refreshes data sources for the report.

report.refresh();

function refresh(): Promise<void>

Returns

Remove context menu extension command.

report.removeContextMenuCommand(commandName, contextMenuTitle)
 .catch(error => {
     ...
 });

function removeContextMenuCommand(commandName: string, contextMenuTitle: string): Promise<IHttpPostMessageResponse<void>>

Parameters

Returns

Removes all filters at the report level.

report.removeFilters();

function removeFilters(): Promise<IHttpPostMessageResponse<void>>

Returns

Remove options menu extension command.

report.removeOptionsMenuCommand(commandName, optionsMenuTitle)
 .then({
     ...
 });

function removeOptionsMenuCommand(commandName: string, optionsMenuTitle: string): Promise<IHttpPostMessageResponse<void>>

Parameters

Returns

Rename a page from a report

// Rename a page from a report by changing displayName (pageName is different from the display name and can be acquired from the getPages API)
report.renamePage("ReportSection145", "Sales");

function renamePage(pageName: string, displayName: string): Promise<void>

Parameters

Returns

Render a preloaded report, using phased embedding API

// Load report
var report = powerbi.load(element, config);

...

// Render report
report.render()

function render(config?: IReportEmbedConfiguration | IReportLoadConfiguration): Promise<void>

Parameters

Returns

Reset user's filters, slicers, and other data view changes to the default state of the report

report.resetPersistentFilters();

function resetPersistentFilters(): Promise<IHttpPostMessageResponse<void>>

Returns

Reset and apply the default theme of the report

report.resetTheme();

function resetTheme(): Promise<void>

Returns

Updates the size of active page in report.

report.resizeActivePage(pageSizeType, width, height)
  .catch(error => { ... });

function resizeActivePage(pageSizeType: PageSizeType, width?: number, height?: number): Promise<IHttpPostMessageResponse<void>>

Parameters

Returns

Resize a visual in a page.

report.resizeVisual(pageName, visualName, width, height)
  .catch(error => { ... });

function resizeVisual(pageName: string, visualName: string, width: number, height: number): Promise<IHttpPostMessageResponse<void>>

Parameters

Returns

Save user's filters, slicers, and other data view changes of the report

report.savePersistentFilters();

function savePersistentFilters(): Promise<IHttpPostMessageResponse<void>>

Returns

Sets filters at the report level.

const filters: [
   ...
];

report.setFilters(filters)
 .catch(errors => {
   ...
 });

function setFilters(filters: IFilter[]): Promise<IHttpPostMessageResponse<void>>

Parameters

Returns

Sets the active page of the report.

report.setPage("page2")
 .catch(error => { ... });

function setPage(pageName: string): Promise<IHttpPostMessageResponse<void>>

Parameters

Returns

Updates the display state of a visual in a page.

report.setVisualDisplayState(pageName, visualName, displayState)
  .catch(error => { ... });

function setVisualDisplayState(pageName: string, visualName: string, displayState: VisualContainerDisplayMode): Promise<IHttpPostMessageResponse<void>>

Parameters

Returns

Sets the report's zoom level.

function setZoom(zoomLevel: number): Promise<void>

Parameters

Returns

Updates the report layout

report.switchLayout(layoutType);

function switchLayout(layoutType: LayoutType): Promise<IHttpPostMessageResponse<void>>

Parameters

Returns

Switch Report view mode.

function switchMode(viewMode: string | ViewMode): Promise<void>

Parameters

Returns

Update the filters at the report level according to the operation: Add, replace all, replace by target or remove.

report.updateFilters(FiltersOperations.Add, filters)
  .catch(errors => { ... });

function updateFilters(operation: FiltersOperations, filters?: IFilter[]): Promise<IHttpPostMessageResponse<void>>

Parameters

Returns

Updates visibility settings for the filter pane and the page navigation pane.

const newSettings = {
  panes: {
    filters: {
      visible: false
    }
  }
};

report.updateSettings(newSettings)
  .catch(error => { ... });

function updateSettings(settings: ISettings): Promise<IHttpPostMessageResponse<void>>

Parameters

Returns

Requests the browser to exit fullscreen mode.

function exitFullscreen()

Inherited From Embed.exitFullscreen

Requests the browser to render the component's iframe in fullscreen mode.

function fullscreen()

Inherited From Embed.fullscreen

Get the correlationId for the current embed session.

// Get the correlationId for the current embed session
report.getCorrelationId()
  .then(correlationId => {
    ...
  });

function getCorrelationId(): Promise<string>

Returns

Inherited From Embed.getCorrelationId

Removes one or more event handlers from the list of handlers. If a reference to the existing handle function is specified, remove the specific handler. If the handler is not specified, remove all handlers for the event name specified.

report.off('pageChanged')

or

const logHandler = function (event) {
   console.log(event);
};

report.off('pageChanged', logHandler);

function off<T>(eventName: string, handler?: IEventHandler<T>)

Parameters

Inherited From Embed.off

Adds an event handler for a specific event.

report.on('pageChanged', (event) => {
  console.log('PageChanged: ', event.page.name);
});

function on<T>(eventName: string, handler: IEventHandler<T>)

Parameters

Inherited From Embed.on

Reloads embed using existing configuration. E.g. For reports this effectively clears all filters and makes the first page active which simulates resetting a report back to loaded state.

report.reload();

function reload(): Promise<void>

Returns

Inherited From Embed.reload

Removes element's tabindex attribute

function removeComponentTabIndex(_tabIndex?: number)

Parameters

Inherited From Embed.removeComponentTabIndex

Saves Report.

function save(): Promise<void>

Returns

Inherited From Embed.save

SaveAs Report.

function saveAs(saveAsParameters: ISaveAsParameters): Promise<void>

Parameters

Returns

Inherited From Embed.saveAs

Set accessToken.

function setAccessToken(accessToken: string): Promise<void>

Parameters

Returns

Inherited From Embed.setAccessToken

Sets element's tabindex attribute

function setComponentTabIndex(tabIndex?: number)

Parameters

Inherited From Embed.setComponentTabIndex

Set the component title for accessibility. In case of iframes, this method will change the iframe title.

function setComponentTitle(title: string)

Parameters

Inherited From Embed.setComponentTitle