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()	從第一個可用位置取得報表標識碼：選項、屬性、內嵌 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()

從第一個可用位置取得報表標識碼：選項、屬性、內嵌 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

共用方式為

Report class

屬性

方法

繼承的方法

屬性詳細資料

bookmarksManager

屬性值

方法詳細資料

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

參數

傳回

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

參數

傳回

addPage(string)

參數

傳回

applyTheme(IReportTheme)

參數

傳回

arePersistentFiltersApplied()

傳回

clearSelectedVisuals(boolean)

參數

傳回

closeAllOverlays()

傳回

configChanged(boolean)

參數

deletePage(string)

參數

傳回

getActivePage()

傳回

getFilters()

傳回

getId()

傳回

getPageByName(string)

參數

傳回

getPages()

傳回

getTheme()

傳回

getZoom()

傳回

isSaved()

傳回

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

參數

傳回

print()

傳回

refresh()

傳回

removeContextMenuCommand(string, string)

參數

傳回

removeFilters()

傳回

removeOptionsMenuCommand(string, string)

參數

傳回

renamePage(string, string)

參數

傳回

render(IReportEmbedConfiguration | IReportLoadConfiguration)

參數

傳回

resetPersistentFilters()

傳回

resetTheme()

傳回

resizeActivePage(PageSizeType, number, number)

參數

傳回

resizeVisual(string, string, number, number)

參數