Page class

Page background color.

background: IPageBackground

Property Value

Page display options as saved in the report.

defaultDisplayOption: DisplayOption

Property Value

Page size as saved in the report.

defaultSize: ICustomPageSize

Property Value

The user defined display name of the report page, which is undefined if the page is created manually

displayName: string

Property Value

Is this page is the active page

isActive: boolean

Property Value

Mobile view page size (if defined) as saved in the report.

mobileSize: ICustomPageSize

Property Value

The report page name

name: string

Property Value

The parent Power BI report that this page is a member of

report: IReportNode

Property Value

The visibility of the page. 0 - Always Visible 1 - Hidden in View Mode

visibility: SectionVisibility

Property Value

Page wallpaper color.

wallpaper: IPageWallpaper

Property Value

Delete the page from the report

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

function delete(): Promise<void>

Returns

Gets all page level filters within the report.

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

function getFilters(): Promise<IFilter[]>

Returns

Gets the list of slicer visuals on the page.

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

function getSlicers(): Promise<IVisual[]>

Returns

Get insights for report page

page.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

Returns

Gets a visual by name on the page.

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

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

Parameters

Returns

Gets all the visuals on the page.

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

function getVisuals(): Promise<VisualDescriptor[]>

Returns

Checks if page has layout.

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

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

Parameters

Returns

Updates the position of a visual in a page.

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

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

Parameters

Returns

Removes all filters from this page of the report.

page.removeFilters();

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

Returns

Updates the size of active page.

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

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

Parameters

Returns

Resize a visual in a page.

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

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

Parameters

Returns

Makes the current page the active page of the report.

page.setActive();

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

Returns

Set displayName to the current page.

page.setName(displayName);

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

Parameters

Returns

Sets all filters on the current page.

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

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

Parameters

Returns

Updates the display state of a visual in a page.

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

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

Parameters

Returns

Update the filters for the current page according to the operation: Add, replace all, replace by target or remove.

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

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

Parameters

Returns