Report class

参考

包:: powerbi-client

Power BI 报表嵌入组件

Extends: Embed

属性

方法

addContextMenuCommand(string, string, string, MenuLocation, string, string, string)	添加上下文菜单扩展命令。 `report.addContextMenuCommand(commandName, commandTitle, contextMenuTitle, menuLocation, visualName, visualType, groupName) .catch(error => { ... });`
addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)	添加选项菜单扩展命令。 `report.addOptionsMenuCommand(commandName, commandTitle, optionsMenuTitle, menuLocation, visualName, visualType, groupName, commandIcon) .catch(error => { ... });`
addPage(string)	向报表添加空页 `// Add a page to the report with "Sales" as the page display name report.addPage("Sales");`
applyTheme(IReportTheme)	将主题应用于报表 `report.applyTheme(theme);`
arePersistentFiltersApplied()	如果报表上应用了用户的筛选器、切片器或其他数据视图更改，则返回。如果禁用永久性筛选器，则返回 false。 `report.arePersistentFiltersApplied();`
clearSelectedVisuals(boolean)	清除选中的未弹出的视觉对象，如果传递标志，将清除所有视觉对象选择。 `report.clearSelectedVisuals() .then(() => { ... });`
closeAllOverlays()	关闭所有打开的上下文菜单和工具提示。 `report.closeAllOverlays() .then(() => { ... });`
configChanged(boolean)	处理配置更改。
deletePage(string)	从报表中删除页面 `// 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");`
getActivePage()	获取活动报表页。 `report.getActivePage() .then(activePage => { ... });`
getFilters()	获取在报表级别应用的筛选器。 `// Get filters applied at report level report.getFilters() .then(filters => { ... });`
getId()	从第一个可用位置获取报表 ID：选项、属性、嵌入 URL。
getPageByName(string)	按报表页的名称获取报表页。 `report.getPageByName(pageName) .then(page => { ... });`
getPages()	获取报表中的页列表。 `report.getPages() .then(pages => { ... });`
getTheme()	获取报表的主题 `report.getTheme();`
getZoom()	返回报表的当前缩放级别。
isSaved()	检查报表是否已保存。 `report.isSaved()`
moveVisual(string, string, number, number, number)	汇报视觉对象在页面中的位置。 `report.moveVisual(pageName, visualName, x, y, z) .catch(error => { ... });`
print()	通过在嵌入 iframe 组件上调用 `window.print()` 来打印报表的活动页。
refresh()	刷新报表的数据源。 `report.refresh();`
removeContextMenuCommand(string, string)	删除上下文菜单扩展命令。 `report.removeContextMenuCommand(commandName, contextMenuTitle) .catch(error => { ... });`
removeFilters()	删除报表级别的所有筛选器。 `report.removeFilters();`
removeOptionsMenuCommand(string, string)	“删除选项”菜单扩展命令。 `report.removeOptionsMenuCommand(commandName, optionsMenuTitle) .then({ ... });`
renamePage(string, string)	重命名报表中的页面 `// 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");`
render(IReportEmbedConfiguration \| IReportLoadConfiguration)	使用分阶段嵌入 API 呈现预加载的报表 `// Load report var report = powerbi.load(element, config); ... // Render report report.render()`
resetPersistentFilters()	将用户的筛选器、切片器和其他数据视图更改重置为报表的默认状态 `report.resetPersistentFilters();`
resetTheme()	重置并应用报表的默认主题 `report.resetTheme();`
resizeActivePage(PageSizeType, number, number)	汇报报表中活动页的大小。 `report.resizeActivePage(pageSizeType, width, height) .catch(error => { ... });`
resizeVisual(string, string, number, number)	在页面中调整视觉对象的大小。 `report.resizeVisual(pageName, visualName, width, height) .catch(error => { ... });`
savePersistentFilters()	保存用户的筛选器、切片器和其他报表数据视图更改 `report.savePersistentFilters();`
setFilters(IFilter[])	在报表级别设置筛选器。 `const filters: [ ... ]; report.setFilters(filters) .catch(errors => { ... });`
setPage(string)	设置报表的活动页。 `report.setPage("page2") .catch(error => { ... });`
setVisualDisplayState(string, string, VisualContainerDisplayMode)	汇报页面中视觉对象的显示状态。 `report.setVisualDisplayState(pageName, visualName, displayState) .catch(error => { ... });`
setZoom(number)	设置报表的缩放级别。
switchLayout(LayoutType)	汇报报表布局 `report.switchLayout(layoutType);`
switchMode(string \| ViewMode)	切换报表视图模式。
updateFilters(FiltersOperations, IFilter[])	根据以下操作在报表级别更新筛选器：添加、全部替换、按目标替换或删除。 `report.updateFilters(FiltersOperations.Add, filters) .catch(errors => { ... });`
updateSettings(ISettings)	汇报筛选器窗格和页面导航窗格的可见性设置。 `const newSettings = { panes: { filters: { visible: false } } }; report.updateSettings(newSettings) .catch(error => { ... });`

继承的方法

exitFullscreen()	请求浏览器退出全屏模式。
fullscreen()	请求浏览器以全屏模式呈现组件的 iframe。
getCorrelationId()	获取当前嵌入会话的 correlationId。 `// Get the correlationId for the current embed session report.getCorrelationId() .then(correlationId => { ... });`
off<T>(string, IEventHandler<T>)	从处理程序列表中删除一个或多个事件处理程序。如果指定了对现有句柄函数的引用，请删除特定的处理程序。如果未指定处理程序，请删除指定事件名称的所有处理程序。 `report.off('pageChanged') or const logHandler = function (event) { console.log(event); }; report.off('pageChanged', logHandler);`
on<T>(string, IEventHandler<T>)	为特定事件添加事件处理程序。 `report.on('pageChanged', (event) => { console.log('PageChanged: ', event.page.name); });`
reload()	使用现有配置重新加载嵌入。例如，对于报表，这将有效地清除所有筛选器，并使第一页处于活动状态，以模拟将报表重置回加载状态。 `report.reload();`
removeComponentTabIndex(number)	删除元素的 tabindex 属性
save()	保存报表。
saveAs(ISaveAsParameters)	SaveAs 报表。
setAccessToken(string)	设置 accessToken。
setComponentTabIndex(number)	设置元素的 tabindex 属性
setComponentTitle(string)	设置辅助功能的组件标题。对于 iframe，此方法将更改 iframe 标题。

属性详细信息

bookmarksManager

bookmarksManager: BookmarksManager

属性值

BookmarksManager

方法详细信息

addContextMenuCommand(string, string, string, MenuLocation, string, string, string)

添加上下文菜单扩展命令。

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>>

参数

commandName: string

commandTitle: string

contextMenuTitle: string

menuLocation: MenuLocation

visualName: string

visualType: string

groupName: string

Promise<IHttpPostMessageResponse<void>>

addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)

添加选项菜单扩展命令。

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>>

参数

commandName: string

commandTitle: string

optionsMenuTitle: string

menuLocation: MenuLocation

visualName: string

visualType: string

groupName: string

commandIcon: string

Promise<IHttpPostMessageResponse<void>>

addPage(string)

向报表添加空页

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

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

参数

displayName: string

Promise<Page>

applyTheme(IReportTheme)

将主题应用于报表

report.applyTheme(theme);

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

参数

theme: IReportTheme

Promise<void>

arePersistentFiltersApplied()

如果报表上应用了用户的筛选器、切片器或其他数据视图更改，则返回。如果禁用永久性筛选器，则返回 false。

report.arePersistentFiltersApplied();

function arePersistentFiltersApplied(): Promise<boolean>

Promise<boolean>

clearSelectedVisuals(boolean)

清除选中的未弹出的视觉对象，如果传递标志，将清除所有视觉对象选择。

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

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

参数

clearPopOutState: boolean

如果其中一个视觉对象处于弹出状态 (焦点，则无法清除 false/未定义的视觉对象选择，则显示为表、聚焦...)

Promise<void>

closeAllOverlays()

关闭所有打开的上下文菜单和工具提示。

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

function closeAllOverlays(): Promise<void>

Promise<void>

configChanged(boolean)

处理配置更改。

function configChanged(isBootstrap: boolean)

参数

isBootstrap: boolean

deletePage(string)

从报表中删除页面

// 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>

参数

pageName: string

Promise<void>

getActivePage()

获取活动报表页。

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

function getActivePage(): Promise<Page>

Promise<Page>

getFilters()

获取在报表级别应用的筛选器。

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

function getFilters(): Promise<IFilter[]>

Promise<IFilter[]>

getId()

从第一个可用位置获取报表 ID：选项、属性、嵌入 URL。

function getId(): string

string

getPageByName(string)

按报表页的名称获取报表页。

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

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

参数

pageName: string

Promise<Page>

getPages()

获取报表中的页列表。

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

function getPages(): Promise<Page[]>

Promise<Page[]>

getTheme()

获取报表的主题

report.getTheme();

function getTheme(): Promise<IReportTheme>

Promise<IReportTheme>

getZoom()

返回报表的当前缩放级别。

function getZoom(): Promise<number>

Promise<number>

isSaved()

检查报表是否已保存。

report.isSaved()

function isSaved(): Promise<boolean>

Promise<boolean>

moveVisual(string, string, number, number, number)

汇报视觉对象在页面中的位置。

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

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

参数

pageName: string

visualName: string

x: number

y: number

z: number

Promise<IHttpPostMessageResponse<void>>

print()

通过在嵌入 iframe 组件上调用 window.print() 来打印报表的活动页。

function print(): Promise<void>

Promise<void>

refresh()

刷新报表的数据源。

report.refresh();

function refresh(): Promise<void>

Promise<void>

removeContextMenuCommand(string, string)

删除上下文菜单扩展命令。

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

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

参数

commandName: string

contextMenuTitle: string

Promise<IHttpPostMessageResponse<void>>

removeFilters()

删除报表级别的所有筛选器。

report.removeFilters();

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

Promise<IHttpPostMessageResponse<void>>

removeOptionsMenuCommand(string, string)

“删除选项”菜单扩展命令。

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

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

参数

commandName: string

optionsMenuTitle: string

Promise<IHttpPostMessageResponse<void>>

renamePage(string, string)

重命名报表中的页面

// 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>

参数

pageName: string

displayName: string

Promise<void>

render(IReportEmbedConfiguration | IReportLoadConfiguration)

使用分阶段嵌入 API 呈现预加载的报表

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

...

// Render report
report.render()

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

参数

config: IReportEmbedConfiguration | IReportLoadConfiguration

Promise<void>

resetPersistentFilters()

将用户的筛选器、切片器和其他数据视图更改重置为报表的默认状态

report.resetPersistentFilters();

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

Promise<IHttpPostMessageResponse<void>>

resetTheme()

重置并应用报表的默认主题

report.resetTheme();

function resetTheme(): Promise<void>

Promise<void>

resizeActivePage(PageSizeType, number, number)

汇报报表中活动页的大小。

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

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

参数

pageSizeType: PageSizeType

width: number

height: number

Promise<IHttpPostMessageResponse<void>>

resizeVisual(string, string, number, number)

在页面中调整视觉对象的大小。

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

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

参数

pageName: string

visualName: string

width: number

height: number

Promise<IHttpPostMessageResponse<void>>

savePersistentFilters()

保存用户的筛选器、切片器和其他报表数据视图更改

report.savePersistentFilters();

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

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

在报表级别设置筛选器。

const filters: [
   ...
];

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

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

参数

filters: IFilter[]

Promise<IHttpPostMessageResponse<void>>

setPage(string)

设置报表的活动页。

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

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

参数

pageName: string

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(string, string, VisualContainerDisplayMode)

汇报页面中视觉对象的显示状态。

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

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

参数

pageName: string

visualName: string

displayState: VisualContainerDisplayMode

Promise<IHttpPostMessageResponse<void>>

setZoom(number)

设置报表的缩放级别。

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

参数

zoomLevel: number

要设置的缩放级别

Promise<void>

switchLayout(LayoutType)

汇报报表布局

report.switchLayout(layoutType);

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

参数

layoutType: LayoutType

Promise<IHttpPostMessageResponse<void>>

switchMode(string | ViewMode)

切换报表视图模式。

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

参数

viewMode: string | ViewMode

Promise<void>

updateFilters(FiltersOperations, IFilter[])

根据以下操作在报表级别更新筛选器：添加、全部替换、按目标替换或删除。

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

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

参数

operation: FiltersOperations

filters: IFilter[]

Promise<IHttpPostMessageResponse<void>>

updateSettings(ISettings)

汇报筛选器窗格和页面导航窗格的可见性设置。

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

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

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

参数

settings: ISettings

Promise<IHttpPostMessageResponse<void>>

继承的方法详细信息

exitFullscreen()

请求浏览器退出全屏模式。

function exitFullscreen()

继承自 Embed.exitFullscreen

fullscreen()

请求浏览器以全屏模式呈现组件的 iframe。

function fullscreen()

继承自 Embed.fullscreen

getCorrelationId()

获取当前嵌入会话的 correlationId。

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

function getCorrelationId(): Promise<string>

Promise<string>

继承自 Embed.getCorrelationId

off<T>(string, IEventHandler<T>)

从处理程序列表中删除一个或多个事件处理程序。如果指定了对现有句柄函数的引用，请删除特定的处理程序。如果未指定处理程序，请删除指定事件名称的所有处理程序。

report.off('pageChanged')

or

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

report.off('pageChanged', logHandler);

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

参数

eventName: string

handler: IEventHandler<T>

继承自 Embed.off

on<T>(string, IEventHandler<T>)

为特定事件添加事件处理程序。

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

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

参数

eventName: string

handler: IEventHandler<T>

继承自 Embed.on

reload()

使用现有配置重新加载嵌入。例如，对于报表，这将有效地清除所有筛选器，并使第一页处于活动状态，以模拟将报表重置回加载状态。

report.reload();

function reload(): Promise<void>

Promise<void>

继承自 Embed.reload

removeComponentTabIndex(number)

删除元素的 tabindex 属性

function removeComponentTabIndex(_tabIndex?: number)

参数

_tabIndex: number

继承自 Embed.removeComponentTabIndex

save()

保存报表。

function save(): Promise<void>

Promise<void>

继承自 Embed.save

saveAs(ISaveAsParameters)

SaveAs 报表。

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

参数

saveAsParameters: ISaveAsParameters

Promise<void>

继承自 Embed.saveAs

setAccessToken(string)

设置 accessToken。

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

参数

accessToken: string

Promise<void>

继承自 Embed.setAccessToken

setComponentTabIndex(number)

设置元素的 tabindex 属性

function setComponentTabIndex(tabIndex?: number)

参数

tabIndex: number

继承自 Embed.setComponentTabIndex

setComponentTitle(string)

设置辅助功能的组件标题。对于 iframe，此方法将更改 iframe 标题。

function setComponentTitle(title: string)

参数

title: string

继承自 Embed.setComponentTitle