Partager via

Page class

  • Référence
Paquet:
powerbi-client

Page de rapport Power BI

Propriétés

background

Couleur d’arrière-plan de la page.
defaultDisplayOption

Options d’affichage de page enregistrées dans le rapport.
defaultSize

Taille de page enregistrée dans le rapport.
displayName

Nom complet défini par l’utilisateur de la page de rapport, qui n’est pas défini si la page est créée manuellement
isActive

Cette page est-elle la page active
mobileSize

Taille de page d’affichage mobile (si définie) comme enregistrée dans le rapport.
name

Nom de la page de rapport
report

Rapport Power BI parent dont cette page est membre
visibility

Visibilité de la page. 0 - Toujours visible 1 - Masqué en mode Affichage
wallpaper

Couleur de papier peint de page.

Méthodes

delete()

Supprimer la page du rapport

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

Obtient tous les filtres au niveau de la page dans le rapport.

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

Obtient la liste des visuels de segment sur la page.

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

Obtenir des insights pour la page de rapport

page.getSmartNarrativeInsights();
getVisualByName(string)

Obtient un visuel par nom sur la page.

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

Obtient tous les visuels de la page.

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

Vérifie si la page a une mise en page.

page.hasLayout(layoutType)
 .then(hasLayout: boolean => { ... });
moveVisual(string, number, number, number)

Met à jour la position d’un visuel dans une page.

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

Supprime tous les filtres de cette page du rapport.

page.removeFilters();
resizePage(PageSizeType, number, number)

Met à jour la taille de la page active.

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

Redimensionnez un visuel dans une page.

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

Rend la page active de la page active du rapport.

page.setActive();
setDisplayName(string)

Définissez displayName sur la page active.

page.setName(displayName);
setFilters(IFilter[])

Définit tous les filtres de la page active.

page.setFilters(filters)
  .catch(errors => { ... });
setVisualDisplayState(string, VisualContainerDisplayMode)

Met à jour l’état d’affichage d’un visuel dans une page.

page.setVisualDisplayState(visualName, displayState)
  .catch(error => { ... });
updateFilters(FiltersOperations, IFilter[])

Mettez à jour les filtres de la page active en fonction de l’opération : Ajoutez, remplacez tout, remplacez par cible ou supprimez.

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

Détails de la propriété

background

Couleur d’arrière-plan de la page.

background: IPageBackground

Valeur de propriété

IPageBackground

defaultDisplayOption

Options d’affichage de page enregistrées dans le rapport.

defaultDisplayOption: DisplayOption

Valeur de propriété

DisplayOption

defaultSize

Taille de page enregistrée dans le rapport.

defaultSize: ICustomPageSize

Valeur de propriété

ICustomPageSize

displayName

Nom complet défini par l’utilisateur de la page de rapport, qui n’est pas défini si la page est créée manuellement

displayName: string

Valeur de propriété

string

isActive

Cette page est-elle la page active

isActive: boolean

Valeur de propriété

boolean

mobileSize

Taille de page d’affichage mobile (si définie) comme enregistrée dans le rapport.

mobileSize: ICustomPageSize

Valeur de propriété

ICustomPageSize

name

Nom de la page de rapport

name: string

Valeur de propriété

string

report

Rapport Power BI parent dont cette page est membre

report: IReportNode

Valeur de propriété

IReportNode

visibility

Visibilité de la page. 0 - Toujours visible 1 - Masqué en mode Affichage

visibility: SectionVisibility

Valeur de propriété

SectionVisibility

wallpaper

Couleur de papier peint de page.

wallpaper: IPageWallpaper

Valeur de propriété

IPageWallpaper

Détails de la méthode

delete()

Supprimer la page du rapport

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

function delete(): Promise<void>

Retours

Promise<void>

getFilters()

Obtient tous les filtres au niveau de la page dans le rapport.

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

function getFilters(): Promise<IFilter[]>

Retours

Promise<IFilter[]>

getSlicers()

Obtient la liste des visuels de segment sur la page.

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

function getSlicers(): Promise<IVisual[]>

Retours

Promise<IVisual[]>

getSmartNarrativeInsights()

Obtenir des insights pour la page de rapport

page.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

Retours

Promise<ISmartNarratives>

getVisualByName(string)

Obtient un visuel par nom sur la page.

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

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

Paramètres

visualName

string

Retours

Promise<VisualDescriptor>

getVisuals()

Obtient tous les visuels de la page.

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

function getVisuals(): Promise<VisualDescriptor[]>

Retours

Promise<VisualDescriptor[]>

hasLayout(LayoutType)

Vérifie si la page a une mise en page.

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

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

Paramètres

layoutType
LayoutType

Retours

Promise<boolean>

moveVisual(string, number, number, number)

Met à jour la position d’un visuel dans une page.

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

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

Paramètres

visualName

string

x

number

y

number

z

number

Retours

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Supprime tous les filtres de cette page du rapport.

page.removeFilters();

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

Retours

Promise<IHttpPostMessageResponse<void>>

resizePage(PageSizeType, number, number)

Met à jour la taille de la page active.

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

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

Paramètres

pageSizeType
PageSizeType
width

number

height

number

Retours

Promise<IHttpPostMessageResponse<void>>

resizeVisual(string, number, number)

Redimensionnez un visuel dans une page.

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

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

Paramètres

visualName

string

width

number

height

number

Retours

Promise<IHttpPostMessageResponse<void>>

setActive()

Rend la page active de la page active du rapport.

page.setActive();

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

Retours

Promise<IHttpPostMessageResponse<void>>

setDisplayName(string)

Définissez displayName sur la page active.

page.setName(displayName);

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

Paramètres

displayName

string

Retours

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Définit tous les filtres de la page active.

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

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

Paramètres

filters

IFilter[]

Retours

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(string, VisualContainerDisplayMode)

Met à jour l’état d’affichage d’un visuel dans une page.

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

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

Paramètres

visualName

string

displayState
VisualContainerDisplayMode

Retours

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

Mettez à jour les filtres de la page active en fonction de l’opération : Ajoutez, remplacez tout, remplacez par cible ou supprimez.

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

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

Paramètres

operation
FiltersOperations
filters

IFilter[]

Retours

Promise<IHttpPostMessageResponse<void>>