Report class
Power BI 報表內嵌元件
- Extends
-
Embed
屬性
bookmarks |
方法
add |
新增操作功能表延伸模組命令。
|
add |
新增選項功能表延伸模組命令。
|
add |
將空白頁面新增至報表
|
apply |
將主題套用至報表
|
are |
如果報表上套用了使用者的篩選、交叉分析篩選器或其他資料檢視變更,則傳回 。 如果永續性篩選已停用,則傳回 false。
|
clear |
清除選取的未彈出視覺效果,如果傳遞旗標,則會清除所有視覺效果選取專案。
|
close |
關閉所有開啟的內容功能表和工具提示。
|
config |
處理組態變更。 |
delete |
從報表中刪除頁面
|
get |
取得使用中的報表頁面。
|
get |
取得在報表層級套用的篩選。
|
get |
從第一個可用位置取得報表識別碼:選項、屬性、內嵌 URL。 |
get |
依報表頁面的名稱取得報表頁面。
|
get |
取得報表內的頁面清單。
|
get |
取得報表的主題
|
get |
傳回報表目前的縮放層級。 |
is |
會檢查是否儲存報表。
|
move |
更新視覺效果在頁面中的位置。
|
print() | 叫用內嵌 iframe 元件,以 |
refresh() | 重新整理報表的資料來源。
|
remove |
移除操作功能表延伸模組命令。
|
remove |
移除報表層級的所有篩選。
|
remove |
移除選項功能表延伸模組命令。
|
rename |
從報表重新命名頁面
|
render(IReport |
使用階段式內嵌 API 轉譯預先載入的報表
|
reset |
將使用者的篩選、交叉分析篩選器和其他資料檢視變更重設為報表的預設狀態
|
reset |
重設並套用報表的預設主題
|
resize |
更新報表中的使用中頁面大小。
|
resize |
調整頁面中視覺效果的大小。
|
save |
儲存使用者的篩選、交叉分析篩選器和其他報表的資料檢視變更
|
set |
在報表層級設定篩選。
|
set |
設定報表的作用中頁面。
|
set |
更新頁面中視覺效果的顯示狀態。
|
set |
設定報表的縮放層級。 |
switch |
更新報表配置
|
switch |
切換報表檢視模式。 |
update |
根據作業更新報表層級的篩選:新增、取代全部、以目標取代或移除。
|
update |
更新篩選窗格和頁面流覽窗格的可見度設定。
|
繼承的方法
exit |
要求瀏覽器結束全螢幕模式。 |
fullscreen() | 要求瀏覽器以全螢幕模式轉譯元件的 iframe。 |
get |
取得目前內嵌會話的 correlationId。
|
off<T>(string, IEvent |
從處理常式清單中移除一或多個事件處理常式。 如果指定了現有控制碼函式的參考,請移除特定的處理常式。 如果未指定處理常式,請移除指定之事件名稱的所有處理常式。
|
on<T>(string, IEvent |
新增特定事件的事件處理常式。
|
reload() | 使用現有的組態重載內嵌。 例如,對於報表,這會有效地清除所有篩選,並讓第一頁處於作用中狀態,以模擬將報表重設回載入的狀態。
|
remove |
移除專案的 Tabindex 屬性 |
save() | 儲存報表。 |
save |
SaveAs 報表。 |
set |
設定 accessToken。 |
set |
設定專案的 Tabindex 屬性 |
set |
設定協助工具的元件標題。 如果是 iframe,這個方法將會變更 iframe 標題。 |
屬性詳細資料
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()
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>
參數
傳回
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