Page class

套件:

powerbi-client

Power BI 報表頁面

屬性

background	頁面背景色彩。
defaultDisplayOption	頁面顯示選項儲存在報表中。
defaultSize	儲存在報表中的頁面大小。
displayName	使用者定義報表頁面的顯示名稱，如果手動建立頁面，則為未定義
isActive	此頁面是否為使用中頁面
mobileSize	如果定義) 儲存在報表中，則為行動檢視頁面大小 (。
name	報表頁面名稱
report	此頁面所屬的父Power BI報表
visibility	頁面的可見性。 0 - 永遠可見 1 - 隱藏在檢視模式中
wallpaper	頁面背景圖案色彩。

方法

delete()	從報表中刪除頁面 // Delete the page from the report page.delete();
getFilters()	取得報表內的所有頁面層級篩選。 page.getFilters() .then(filters => { ... });
getSlicers()	取得頁面上交叉分析篩選器視覺效果的清單。 page.getSlicers() .then(slicers => { ... });
getSmartNarrativeInsights()	取得報表頁面的深入解析 page.getSmartNarrativeInsights();
getVisualByName(string)	依名稱取得頁面上的視覺效果。 page.getVisualByName(visualName: string) .then(visual => { ... });
getVisuals()	取得頁面上的所有視覺效果。 page.getVisuals() .then(visuals => { ... });
hasLayout(LayoutType)	檢查頁面是否具有版面配置。 page.hasLayout(layoutType) .then(hasLayout: boolean => { ... });
moveVisual(string, number, number, number)	匯報 視覺效果在頁面中的位置。 page.moveVisual(visualName, x, y, z) .catch(error => { ... });
removeFilters()	從報表的這個頁面移除所有篩選。 page.removeFilters();
resizePage(PageSizeType, number, number)	匯報 使用中頁面的大小。 page.resizePage(pageSizeType, width, height) .catch(error => { ... });
resizeVisual(string, number, number)	調整頁面中的視覺效果大小。 page.resizeVisual(visualName, width, height) .catch(error => { ... });
setActive()	將目前頁面設定為報表的作用中頁面。 page.setActive();
setDisplayName(string)	將 displayName 設定為目前的頁面。 page.setName(displayName);
setFilters(IFilter[])	設定目前頁面上的所有篩選。 page.setFilters(filters) .catch(errors => { ... });
setVisualDisplayState(string, VisualContainerDisplayMode)	匯報 頁面中視覺效果的顯示狀態。 page.setVisualDisplayState(visualName, displayState) .catch(error => { ... });
updateFilters(FiltersOperations, IFilter[])	根據作業更新目前頁面的篩選：新增、全部取代、以目標取代或移除。 page.updateFilters(FiltersOperations.Add, filters) .catch(errors => { ... });

屬性詳細資料

background

頁面背景色彩。

background: IPageBackground

屬性值

IPageBackground

defaultDisplayOption

頁面顯示選項儲存在報表中。

defaultDisplayOption: DisplayOption

屬性值

DisplayOption

defaultSize

儲存在報表中的頁面大小。

defaultSize: ICustomPageSize

屬性值

ICustomPageSize

displayName

使用者定義報表頁面的顯示名稱，如果手動建立頁面，則為未定義

displayName: string

屬性值

string

isActive

此頁面是否為使用中頁面

isActive: boolean

屬性值

boolean

mobileSize

如果定義) 儲存在報表中，則為行動檢視頁面大小 (。

mobileSize: ICustomPageSize

屬性值

ICustomPageSize

name

報表頁面名稱

name: string

屬性值

string

report

此頁面所屬的父Power BI報表

report: IReportNode

屬性值

IReportNode

visibility

頁面的可見性。 0 - 永遠可見 1 - 隱藏在檢視模式中

visibility: SectionVisibility

屬性值

SectionVisibility

wallpaper

頁面背景圖案色彩。

wallpaper: IPageWallpaper

屬性值

IPageWallpaper

方法詳細資料

delete()

從報表中刪除頁面

// Delete the page from the report
page.delete();

function delete(): Promise<void>

傳回

Promise<void>

getFilters()

取得報表內的所有頁面層級篩選。

page.getFilters()
 .then(filters => { ... });

function getFilters(): Promise<IFilter[]>

傳回

Promise<IFilter[]>

getSlicers()

取得頁面上交叉分析篩選器視覺效果的清單。

page.getSlicers()
 .then(slicers => {
     ...
 });

function getSlicers(): Promise<IVisual[]>

傳回

Promise<IVisual[]>

getSmartNarrativeInsights()

取得報表頁面的深入解析

page.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

傳回

Promise<ISmartNarratives>

getVisualByName(string)

依名稱取得頁面上的視覺效果。

page.getVisualByName(visualName: string)
 .then(visual => {
     ...
 });

function getVisualByName(visualName: string): Promise<VisualDescriptor>

參數

visualName

string

傳回

Promise<VisualDescriptor>

getVisuals()

取得頁面上的所有視覺效果。

page.getVisuals()
  .then(visuals => { ... });

function getVisuals(): Promise<VisualDescriptor[]>

傳回

Promise<VisualDescriptor[]>

hasLayout(LayoutType)

檢查頁面是否具有版面配置。

page.hasLayout(layoutType)
 .then(hasLayout: boolean => { ... });

function hasLayout(layoutType: LayoutType): Promise<boolean>

參數

layoutType

LayoutType

傳回

Promise<boolean>

moveVisual(string, number, number, number)

匯報 視覺效果在頁面中的位置。

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

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

參數

visualName

string

x

number

y

number

z

number

傳回

Promise<IHttpPostMessageResponse<void>>

removeFilters()

從報表的這個頁面移除所有篩選。

page.removeFilters();

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

傳回

Promise<IHttpPostMessageResponse<void>>

resizePage(PageSizeType, number, number)

匯報 使用中頁面的大小。

page.resizePage(pageSizeType, width, height)
  .catch(error => { ... });

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

參數

pageSizeType

PageSizeType

width

number

height

number

傳回

Promise<IHttpPostMessageResponse<void>>

resizeVisual(string, number, number)

調整頁面中的視覺效果大小。

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

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

參數

visualName

string

width

number

height

number

傳回

Promise<IHttpPostMessageResponse<void>>

setActive()

將目前頁面設定為報表的作用中頁面。

page.setActive();

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

傳回

Promise<IHttpPostMessageResponse<void>>

setDisplayName(string)

將 displayName 設定為目前的頁面。

page.setName(displayName);

function setDisplayName(displayName: string): Promise<IHttpPostMessageResponse<void>>

參數

displayName

string

傳回

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

設定目前頁面上的所有篩選。

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

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

參數

filters

IFilter[]

傳回

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(string, VisualContainerDisplayMode)

匯報 頁面中視覺效果的顯示狀態。

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

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

參數

visualName

string

displayState

VisualContainerDisplayMode

傳回

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

根據作業更新目前頁面的篩選：新增、全部取代、以目標取代或移除。

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

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

參數

operation

FiltersOperations

filters

IFilter[]

傳回

Promise<IHttpPostMessageResponse<void>>