Page class

页面背景色。

background: IPageBackground

属性值

在报表中保存的页面显示选项。

defaultDisplayOption: DisplayOption

属性值

报表中保存的页面大小。

defaultSize: ICustomPageSize

属性值

用户定义报表页的显示名称，如果未手动创建该页，则为未定义

displayName: string

属性值

此页面是否为活动页

isActive: boolean

属性值

报表中保存的移动视图页面大小（如果已定义）。

mobileSize: ICustomPageSize

属性值

报表页名称

name: string

属性值

此页所属的父 Power BI 报表

report: IReportNode

属性值

页面的可见性。 0 - 始终可见 1 - 隐藏在视图模式下

visibility: SectionVisibility

属性值

页面壁纸颜色。

wallpaper: IPageWallpaper

属性值

从报表中删除页面

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

function delete(): Promise<void>

返回

获取报表中的所有页面级别筛选器。

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

function getFilters(): Promise<IFilter[]>

返回

获取页面上切片器视觉对象的列表。

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

function getSlicers(): Promise<IVisual[]>

返回

获取报表页的见解

page.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

返回

按页面上的名称获取视觉对象。

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

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

参数

返回

获取页面上的所有视觉对象。

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

function getVisuals(): Promise<VisualDescriptor[]>

返回

检查页面是否具有布局。

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

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

参数

返回

更新视觉对象在页面中的位置。

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

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

参数

返回

从报表的此页面中删除所有筛选器。

page.removeFilters();

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

返回

更新活动页的大小。

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

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

参数

返回

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

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

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

参数

返回

将当前页设置为报表的活动页。

page.setActive();

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

返回

将 displayName 设置为当前页。

page.setName(displayName);

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

参数

返回

设置当前页上的所有筛选器。

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

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

参数

返回

更新页面中视觉对象的显示状态。

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

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

参数

返回

根据操作更新当前页的筛选器：添加、替换所有筛选器、替换为目标或删除。

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

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

参数

返回