Page class
Page de rapport Power BI
Propriétés
background | Couleur d’arrière-plan de la page. |
default |
Options d’affichage de page telles qu’elles sont enregistrées dans le rapport. |
default |
Taille de page telle qu’enregistrée dans le rapport. |
display |
Nom d’affichage défini par l’utilisateur de la page de rapport, qui n’est pas défini si la page est créée manuellement |
is |
Cette page est-elle la page active |
mobile |
Taille de page d’affichage mobile (si définie) comme enregistrée dans le rapport. |
name | Nom de la page de rapport |
report | Le rapport Power BI parent que cette page est membre de |
visibility | Visibilité de la page. 0 - Toujours visible 1 - Masqué en mode Affichage |
wallpaper | Couleur du papier peint page. |
Méthodes
delete() | Supprimer la page du rapport
|
get |
Obtient tous les filtres au niveau de la page dans le rapport.
|
get |
Obtient la liste des visuels de segment sur la page.
|
get |
Obtenir des insights pour la page de rapport
|
get |
Obtient un visuel par son nom sur la page.
|
get |
Obtient tous les visuels de la page.
|
has |
Vérifie si la page a une disposition.
|
move |
Mises à jour la position d’un visuel dans une page.
|
remove |
Supprime tous les filtres de cette page du rapport.
|
resize |
Mises à jour la taille de la page active.
|
resize |
Redimensionnez un visuel dans une page.
|
set |
Fait de la page active la page active du rapport.
|
set |
Définissez displayName sur la page active.
|
set |
Définit tous les filtres de la page active.
|
set |
Mises à jour l’état d’affichage d’un visuel dans une page.
|
update |
Mettez à jour les filtres de la page active en fonction de l’opération : Ajouter, remplacer tout, remplacer par cible ou supprimer.
|
Détails de la propriété
background
defaultDisplayOption
Options d’affichage de page telles qu’elles sont enregistrées dans le rapport.
defaultDisplayOption: DisplayOption
Valeur de propriété
defaultSize
Taille de page telle qu’enregistrée dans le rapport.
defaultSize: ICustomPageSize
Valeur de propriété
displayName
Nom d’affichage 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é
name
Nom de la page de rapport
name: string
Valeur de propriété
string
report
Le rapport Power BI parent que cette page est membre de
report: IReportNode
Valeur de propriété
visibility
Visibilité de la page. 0 - Toujours visible 1 - Masqué en mode Affichage
visibility: SectionVisibility
Valeur de propriété
wallpaper
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 son 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 disposition.
page.hasLayout(layoutType)
.then(hasLayout: boolean => { ... });
function hasLayout(layoutType: LayoutType): Promise<boolean>
Paramètres
- layoutType
- LayoutType
Retours
Promise<boolean>
moveVisual(string, number, number, number)
Mises à 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)
Mises à 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()
Fait de la page active 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)
Mises à 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 : Ajouter, remplacer tout, remplacer par cible ou supprimer.
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>>