Page class

Paket:

powerbi-client

Eine Power BI-Berichtsseite

Eigenschaften

background	Seitenhintergrundfarbe.
defaultDisplayOption	Seitenanzeigeoptionen wie im Bericht gespeichert.
defaultSize	Seitengröße wie im Bericht gespeichert.
displayName	Der benutzerdefinierte Anzeigename der Berichtsseite, die nicht definiert ist, wenn die Seite manuell erstellt wird
isActive	Ist diese Seite die aktive Seite
mobileSize	Größe der mobilen Ansichtsseite (sofern definiert) wie im Bericht gespeichert.
name	Der Name der Berichtsseite
report	Der übergeordnete Power BI-Bericht, dass diese Seite Mitglied ist
visibility	Die Sichtbarkeit der Seite. 0 – Immer sichtbar 1 – Ausgeblendet im Ansichtsmodus
wallpaper	Seitenhintergrundfarbe.

Methoden

delete()	Löschen der Seite aus dem Bericht // Delete the page from the report page.delete();
getFilters()	Ruft alle Filter auf Seitenebene innerhalb des Berichts ab. page.getFilters() .then(filters => { ... });
getSlicers()	Ruft die Liste der Datenschnitt-Visuellen auf der Seite ab. page.getSlicers() .then(slicers => { ... });
getVisualByName(string)	Ruft ein Visuelles nach Namen auf der Seite ab. page.getVisualByName(visualName: string) .then(visual => { ... });
getVisuals()	Ruft alle visuellen Elemente auf der Seite ab. page.getVisuals() .then(visuals => { ... });
hasLayout(LayoutType)	Überprüft, ob die Seite das Layout aufweist. page.hasLayout(layoutType) .then(hasLayout: boolean => { ... });
moveVisual(string, number, number, number)	Aktualisierungen die Position eines visuellen Elements auf einer Seite. page.moveVisual(visualName, x, y, z) .catch(error => { ... });
removeFilters()	Entfernt alle Filter aus dieser Seite des Berichts. page.removeFilters();
resizePage(PageSizeType, number, number)	Aktualisierungen die Größe der aktiven Seite. page.resizePage(pageSizeType, width, height) .catch(error => { ... });
resizeVisual(string, number, number)	Ändern der Größe eines visuellen Elements auf einer Seite. page.resizeVisual(visualName, width, height) .catch(error => { ... });
setActive()	Macht die aktuelle Seite zur aktiven Seite des Berichts. page.setActive();
setDisplayName(string)	Legen Sie "displayName" auf die aktuelle Seite fest. page.setName(displayName);
setFilters(IFilter[])	Legt alle Filter auf der aktuellen Seite fest. page.setFilters(filters) .catch(errors => { ... });
setVisualDisplayState(string, VisualContainerDisplayMode)	Aktualisierungen den Anzeigezustand eines visuellen Elements auf einer Seite. page.setVisualDisplayState(visualName, displayState) .catch(error => { ... });
updateFilters(FiltersOperations, IFilter[])	Aktualisieren Sie die Filter für die aktuelle Seite entsprechend dem Vorgang: Hinzufügen, Ersetzen aller, ersetzen durch Ziel oder Entfernen. page.updateFilters(FiltersOperations.Add, filters) .catch(errors => { ... });

Details zur Eigenschaft

background

Seitenhintergrundfarbe.

background: IPageBackground

Eigenschaftswert

IPageBackground

defaultDisplayOption

Seitenanzeigeoptionen wie im Bericht gespeichert.

defaultDisplayOption: DisplayOption

Eigenschaftswert

DisplayOption

defaultSize

Seitengröße wie im Bericht gespeichert.

defaultSize: ICustomPageSize

Eigenschaftswert

ICustomPageSize

displayName

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

displayName: string

Eigenschaftswert

string

isActive

Ist diese Seite die aktive Seite

isActive: boolean

Eigenschaftswert

boolean

mobileSize

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

mobileSize: ICustomPageSize

Eigenschaftswert

ICustomPageSize

name

Der Name der Berichtsseite

name: string

Eigenschaftswert

string

report

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

report: IReportNode

Eigenschaftswert

IReportNode

visibility

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

visibility: SectionVisibility

Eigenschaftswert

SectionVisibility

wallpaper

Seitenhintergrundfarbe.

wallpaper: IPageWallpaper

Eigenschaftswert

IPageWallpaper

Details zur Methode

delete()

Löschen der Seite aus dem Bericht

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

function delete(): Promise<void>

Gibt zurück

Promise<void>

getFilters()

Ruft alle Filter auf Seitenebene innerhalb des Berichts ab.

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

function getFilters(): Promise<IFilter[]>

Gibt zurück

Promise<IFilter[]>

getSlicers()

Ruft die Liste der Datenschnitt-Visuellen auf der Seite ab.

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

function getSlicers(): Promise<IVisual[]>

Gibt zurück

Promise<IVisual[]>

getVisualByName(string)

Ruft ein Visuelles nach Namen auf der Seite ab.

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

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

Parameter

visualName

string

Gibt zurück

Promise<VisualDescriptor>

getVisuals()

Ruft alle visuellen Elemente auf der Seite ab.

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

function getVisuals(): Promise<VisualDescriptor[]>

Gibt zurück

Promise<VisualDescriptor[]>

hasLayout(LayoutType)

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

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

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

Parameter

layoutType

LayoutType

Gibt zurück

Promise<boolean>

moveVisual(string, number, number, number)

Aktualisierungen 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

visualName

string

x

number

y

number

z

number

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Entfernt alle Filter aus dieser Seite des Berichts.

page.removeFilters();

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

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

resizePage(PageSizeType, number, number)

Aktualisierungen 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

pageSizeType

PageSizeType

width

number

height

number

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

resizeVisual(string, number, number)

Ändern der 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

visualName

string

width

number

height

number

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

setActive()

Macht die aktuelle Seite zur aktiven Seite des Berichts.

page.setActive();

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

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

setDisplayName(string)

Legen Sie "displayName" auf die aktuelle Seite fest.

page.setName(displayName);

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

Parameter

displayName

string

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Legt alle Filter auf der aktuellen Seite fest.

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

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

Parameter

filters

IFilter[]

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(string, VisualContainerDisplayMode)

Aktualisierungen den Anzeigezustand eines visuellen Elements auf einer Seite.

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

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

Parameter

visualName

string

displayState

VisualContainerDisplayMode

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

Aktualisieren Sie die Filter für die aktuelle Seite entsprechend 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

operation

FiltersOperations

filters

IFilter[]

Gibt zurück

Promise<IHttpPostMessageResponse<void>>