通过

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