Page class

Seitenhintergrundfarbe.

background: IPageBackground

Eigenschaftswert

Seitenanzeigeoptionen wie im Bericht gespeichert.

defaultDisplayOption: DisplayOption

Eigenschaftswert

Seitengröße wie im Bericht gespeichert.

defaultSize: ICustomPageSize

Eigenschaftswert

Der benutzerdefinierte Anzeigename der Berichtsseite, die nicht definiert ist, wenn die Seite manuell erstellt wird

displayName: string

Eigenschaftswert

Ist diese Seite die aktive Seite

isActive: boolean

Eigenschaftswert

Größe der mobilen Ansichtsseite (sofern definiert) wie im Bericht gespeichert.

mobileSize: ICustomPageSize

Eigenschaftswert

Der Name der Berichtsseite

name: string

Eigenschaftswert

Der übergeordnete Power BI-Bericht, dass diese Seite Mitglied ist

report: IReportNode

Eigenschaftswert

Die Sichtbarkeit der Seite. 0 – Immer sichtbar 1 – Ausgeblendet im Ansichtsmodus

visibility: SectionVisibility

Eigenschaftswert

Seitenhintergrundfarbe.

wallpaper: IPageWallpaper

Eigenschaftswert

Löschen der Seite aus dem Bericht

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

function delete(): Promise<void>

Gibt zurück

Ruft alle Filter auf Seitenebene innerhalb des Berichts ab.

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

function getFilters(): Promise<IFilter[]>

Gibt zurück

Ruft die Liste der Datenschnittelemente auf der Seite ab.

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

function getSlicers(): Promise<IVisual[]>

Gibt zurück

Abrufen von Einblicken für die Berichtsseite

page.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

Gibt zurück

Ruft ein visuelles Element anhand des Namens auf der Seite ab.

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

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

Parameter

Gibt zurück

Ruft alle visuellen Elemente auf der Seite ab.

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

function getVisuals(): Promise<VisualDescriptor[]>

Gibt zurück

Überprüft, ob die Seite das Layout aufweist.

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

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

Parameter

Gibt zurück

Aktualisiert die Position eines visuellen Elements auf einer Seite.

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

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

Parameter

Gibt zurück

Entfernt alle Filter von dieser Seite des Berichts.

page.removeFilters();

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

Gibt zurück

Aktualisiert die Größe der aktiven Seite.

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

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

Parameter

Gibt zurück

Ändern Sie die Größe eines visuellen Elements auf einer Seite.

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

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

Parameter

Gibt zurück

Macht die aktuelle Seite zur aktiven Seite des Berichts.

page.setActive();

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

Gibt zurück

Legen Sie displayName auf die aktuelle Seite fest.

page.setName(displayName);

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

Parameter

Gibt zurück

Legt alle Filter auf der aktuellen Seite fest.

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

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

Parameter

Gibt zurück

Aktualisiert den Anzeigezustand eines visuellen Elements auf einer Seite.

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

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

Parameter

Gibt zurück

Aktualisieren Sie die Filter für die aktuelle Seite gemäß dem Vorgang: Hinzufügen, Ersetzen aller, Ersetzen durch Ziel oder Entfernen.

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

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

Parameter

Gibt zurück