Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Page

A Power BI report page

export
class

Page

implements

{IPageNode}

implements

{IFilterable}

Hierarchy

  • Page

Implements

Index

Properties

defaultDisplayOption

defaultDisplayOption: DisplayOption

Page display options as saved in the report.

type

{ICustomPageSize}

defaultSize

defaultSize: ICustomPageSize

Page size as saved in the report.

type

{ICustomPageSize}

displayName

displayName: string

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

type

{string}

isActive

isActive: boolean

Is this page is the active page

type

{boolean}

name

name: string

The report page name

type

{string}

report

report: IReportNode

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

type

{IReportNode}

visibility

visibility: SectionVisibility

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

type

{SectionVisibility}

Methods

delete

  • delete(): Promise<void>
  • Delete the page from the report

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

    Returns Promise<void>

getFilters

getVisuals

hasLayout

  • hasLayout(layoutType: LayoutType): Promise<boolean>
  • Checks if page has layout.

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

    Parameters

    Returns Promise<boolean>

removeFilters

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

setActive

  • setActive(): Promise<IHttpPostMessageResponse<void>>
  • Makes the current page the active page of the report.

    page.setActive();

    Returns Promise<IHttpPostMessageResponse<void>>

setDisplayName

  • setDisplayName(displayName: string): Promise<IHttpPostMessageResponse<void>>
  • Set displayName to the current page.

    page.setName(displayName);

    Parameters

    • displayName: string

    Returns Promise<IHttpPostMessageResponse<void>>

setFilters

  • setFilters(filters: IFilter[]): Promise<IHttpPostMessageResponse<void>>
  • Sets all filters on the current page.

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

    Parameters

    Returns Promise<IHttpPostMessageResponse<void>>

updateFilters

  • 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 => { ... });

    Parameters

    Returns Promise<IHttpPostMessageResponse<void>>

Generated using TypeDoc