Report class

Référence

Paquet:: powerbi-client

Composant incorporé power BI Report

Extends: Embed

Propriétés

Méthodes

addContextMenuCommand(string, string, string, MenuLocation, string, string, string)	Ajouter une commande d’extension de menu contextuel. `report.addContextMenuCommand(commandName, commandTitle, contextMenuTitle, menuLocation, visualName, visualType, groupName) .catch(error => { ... });`
addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)	Commande Ajouter une extension de menu Options. `report.addOptionsMenuCommand(commandName, commandTitle, optionsMenuTitle, menuLocation, visualName, visualType, groupName, commandIcon) .catch(error => { ... });`
addPage(string)	Ajouter une page vide au rapport `// Add a page to the report with "Sales" as the page display name report.addPage("Sales");`
applyTheme(IReportTheme)	Appliquer un thème au rapport `report.applyTheme(theme);`
arePersistentFiltersApplied()	Retourne s’il existe des filtres, des segments ou d’autres modifications de vue de données appliquées au rapport. Si les filtres persistants sont désactivés, retourne false. `report.arePersistentFiltersApplied();`
clearSelectedVisuals(boolean)	Efface les visuels sélectionnés et non extraits, si l’indicateur est passé, toutes les sélections de visuels seront effacées. `report.clearSelectedVisuals() .then(() => { ... });`
closeAllOverlays()	Ferme tous les menus contextuels ouverts et les info-bulles. `report.closeAllOverlays() .then(() => { ... });`
configChanged(boolean)	Gérer les modifications de configuration.
deletePage(string)	Supprimer une page d’un rapport `// Delete a page from a report by pageName (PageName is different than the display name and can be acquired from the getPages API) report.deletePage("ReportSection145");`
getActivePage()	Obtient la page de rapport active. `report.getActivePage() .then(activePage => { ... });`
getFilters()	Obtient les filtres appliqués au niveau du rapport. `// Get filters applied at report level report.getFilters() .then(filters => { ... });`
getId()	Obtient l’ID de rapport à partir du premier emplacement disponible : options, attribut, URL incorporée.
getPageByName(string)	Obtient une page de rapport par son nom. `report.getPageByName(pageName) .then(page => { ... });`
getPages()	Obtient la liste des pages du rapport. `report.getPages() .then(pages => { ... });`
getTheme()	obtenir le thème du rapport `report.getTheme();`
getZoom()	Retourne le niveau de zoom actuel du rapport.
isSaved()	vérifie si le rapport est enregistré. `report.isSaved()`
moveVisual(string, string, number, number, number)	Met à jour la position d’un visuel dans une page. `report.moveVisual(pageName, visualName, x, y, z) .catch(error => { ... });`
print()	Imprime la page active du rapport en appelant `window.print()` sur le composant iframe incorporé.
refresh()	Actualise les sources de données du rapport. `report.refresh();`
removeContextMenuCommand(string, string)	Supprimer la commande d’extension de menu contextuel. `report.removeContextMenuCommand(commandName, contextMenuTitle) .catch(error => { ... });`
removeFilters()	Supprime tous les filtres au niveau du rapport. `report.removeFilters();`
removeOptionsMenuCommand(string, string)	Supprimer la commande d’extension de menu Options. `report.removeOptionsMenuCommand(commandName, optionsMenuTitle) .then({ ... });`
renamePage(string, string)	Renommer une page à partir d’un rapport `// Rename a page from a report by changing displayName (pageName is different from the display name and can be acquired from the getPages API) report.renamePage("ReportSection145", "Sales");`
render(IReportEmbedConfiguration \| IReportLoadConfiguration)	Afficher un rapport préchargé à l’aide de l’API d’incorporation par phases `// Load report var report = powerbi.load(element, config); ... // Render report report.render()`
resetPersistentFilters()	Réinitialiser les filtres, segments et autres vues de données de l’utilisateur changent à l’état par défaut du rapport `report.resetPersistentFilters();`
resetTheme()	Réinitialiser et appliquer le thème par défaut du rapport `report.resetTheme();`
resizeActivePage(PageSizeType, number, number)	Met à jour la taille de la page active dans le rapport. `report.resizeActivePage(pageSizeType, width, height) .catch(error => { ... });`
resizeVisual(string, string, number, number)	Redimensionnez un visuel dans une page. `report.resizeVisual(pageName, visualName, width, height) .catch(error => { ... });`
savePersistentFilters()	Enregistrer les filtres, segments et autres modifications d’affichage des données de l’utilisateur du rapport `report.savePersistentFilters();`
setFilters(IFilter[])	Définit des filtres au niveau du rapport. `const filters: [ ... ]; report.setFilters(filters) .catch(errors => { ... });`
setPage(string)	Définit la page active du rapport. `report.setPage("page2") .catch(error => { ... });`
setVisualDisplayState(string, string, VisualContainerDisplayMode)	Met à jour l’état d’affichage d’un visuel dans une page. `report.setVisualDisplayState(pageName, visualName, displayState) .catch(error => { ... });`
setZoom(number)	Définit le niveau de zoom du rapport.
switchLayout(LayoutType)	Met à jour la disposition du rapport `report.switchLayout(layoutType);`
switchMode(string \| ViewMode)	Changer le mode d’affichage Rapport.
updateFilters(FiltersOperations, IFilter[])	Mettez à jour les filtres au niveau du rapport en fonction de l’opération : Ajoutez, remplacez tout, remplacez par cible ou supprimez. `report.updateFilters(FiltersOperations.Add, filters) .catch(errors => { ... });`
updateSettings(ISettings)	Met à jour les paramètres de visibilité pour le volet de filtre et le volet de navigation de page. `const newSettings = { panes: { filters: { visible: false } } }; report.updateSettings(newSettings) .catch(error => { ... });`

Méthodes héritées

exitFullscreen()	Demande au navigateur de quitter le mode plein écran.
fullscreen()	Demande au navigateur d’afficher l’iframe du composant en mode plein écran.
getCorrelationId()	Obtenez l’ID de corrélation pour la session incorporée actuelle. `// Get the correlationId for the current embed session report.getCorrelationId() .then(correlationId => { ... });`
off<T>(string, IEventHandler<T>)	Supprime un ou plusieurs gestionnaires d’événements de la liste des gestionnaires. Si une référence à la fonction de handle existante est spécifiée, supprimez le gestionnaire spécifique. Si le gestionnaire n’est pas spécifié, supprimez tous les gestionnaires pour le nom d’événement spécifié. `report.off('pageChanged') or const logHandler = function (event) { console.log(event); }; report.off('pageChanged', logHandler);`
on<T>(string, IEventHandler<T>)	Ajoute un gestionnaire d’événements pour un événement spécifique. `report.on('pageChanged', (event) => { console.log('PageChanged: ', event.page.name); });`
reload()	Recharge l’incorporation à l’aide de la configuration existante. Par exemple, pour les rapports, cela efface efficacement tous les filtres et active la première page qui simule la réinitialisation d’un rapport à l’état chargé. `report.reload();`
removeComponentTabIndex(number)	Supprime l’attribut tabindex de l’élément
save()	Enregistre le rapport.
saveAs(ISaveAsParameters)	Rapport SaveAs.
setAccessToken(string)	Définissez accessToken.
setComponentTabIndex(number)	Définit l’attribut tabindex de l’élément
setComponentTitle(string)	Définissez le titre du composant pour l’accessibilité. En cas d’iframes, cette méthode modifie le titre de l’iframe.

Détails de la propriété

bookmarksManager

bookmarksManager: BookmarksManager

Valeur de propriété

BookmarksManager

Détails de la méthode

addContextMenuCommand(string, string, string, MenuLocation, string, string, string)

Ajouter une commande d’extension de menu contextuel.

report.addContextMenuCommand(commandName, commandTitle, contextMenuTitle, menuLocation, visualName, visualType, groupName)
 .catch(error => {
     ...
 });

function addContextMenuCommand(commandName: string, commandTitle: string, contextMenuTitle: string, menuLocation: MenuLocation, visualName: string, visualType: string, groupName?: string): Promise<IHttpPostMessageResponse<void>>

Paramètres

commandName: string

commandTitle: string

contextMenuTitle: string

menuLocation: MenuLocation

visualName: string

visualType: string

groupName: string

Retours

Promise<IHttpPostMessageResponse<void>>

addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)

Commande Ajouter une extension de menu Options.

report.addOptionsMenuCommand(commandName, commandTitle, optionsMenuTitle, menuLocation, visualName, visualType, groupName, commandIcon)
 .catch(error => {
     ...
 });

function addOptionsMenuCommand(commandName: string, commandTitle: string, optionsMenuTitle?: string, menuLocation?: MenuLocation, visualName?: string, visualType?: string, groupName?: string, commandIcon?: string): Promise<IHttpPostMessageResponse<void>>

Paramètres

commandName: string

commandTitle: string

optionsMenuTitle: string

menuLocation: MenuLocation

visualName: string

visualType: string

groupName: string

commandIcon: string

Retours

Promise<IHttpPostMessageResponse<void>>

addPage(string)

Ajouter une page vide au rapport

// Add a page to the report with "Sales" as the page display name
report.addPage("Sales");

function addPage(displayName?: string): Promise<Page>

Paramètres

displayName: string

Retours

Promise<Page>

applyTheme(IReportTheme)

Appliquer un thème au rapport

report.applyTheme(theme);

function applyTheme(theme: IReportTheme): Promise<void>

Paramètres

theme: IReportTheme

Retours

Promise<void>

arePersistentFiltersApplied()

Retourne s’il existe des filtres, des segments ou d’autres modifications de vue de données appliquées au rapport. Si les filtres persistants sont désactivés, retourne false.

report.arePersistentFiltersApplied();

function arePersistentFiltersApplied(): Promise<boolean>

Retours

Promise<boolean>

clearSelectedVisuals(boolean)

Efface les visuels sélectionnés et non extraits, si l’indicateur est passé, toutes les sélections de visuels seront effacées.

report.clearSelectedVisuals()
 .then(() => {
     ...
 });

function clearSelectedVisuals(clearPopOutState?: boolean): Promise<void>

Paramètres

clearPopOutState: boolean

Si la sélection des visuels faux /non définis ne sera pas effacée si l’un des visuels est en état de sortie (en focus, afficher sous forme de table, à la une des lumières...)

Retours

Promise<void>

closeAllOverlays()

Ferme tous les menus contextuels ouverts et les info-bulles.

report.closeAllOverlays()
 .then(() => {
     ...
 });

function closeAllOverlays(): Promise<void>

Retours

Promise<void>

configChanged(boolean)

Gérer les modifications de configuration.

function configChanged(isBootstrap: boolean)

Paramètres

isBootstrap: boolean

deletePage(string)

Supprimer une page d’un rapport

// Delete a page from a report by pageName (PageName is different than the display name and can be acquired from the getPages API)
report.deletePage("ReportSection145");

function deletePage(pageName: string): Promise<void>

Paramètres

pageName: string

Retours

Promise<void>

getActivePage()

Obtient la page de rapport active.

report.getActivePage()
 .then(activePage => {
     ...
 });

function getActivePage(): Promise<Page>

Retours

Promise<Page>

getFilters()

Obtient les filtres appliqués au niveau du rapport.

// Get filters applied at report level
report.getFilters()
  .then(filters => {
    ...
  });

function getFilters(): Promise<IFilter[]>

Retours

Promise<IFilter[]>

getId()

Obtient l’ID de rapport à partir du premier emplacement disponible : options, attribut, URL incorporée.

function getId(): string

Retours

string

getPageByName(string)

Obtient une page de rapport par son nom.

report.getPageByName(pageName)
 .then(page => {
     ...
 });

function getPageByName(pageName: string): Promise<Page>

Paramètres

pageName: string

Retours

Promise<Page>

getPages()

Obtient la liste des pages du rapport.

report.getPages()
 .then(pages => {
     ...
 });

function getPages(): Promise<Page[]>

Retours

Promise<Page[]>

getTheme()

obtenir le thème du rapport

report.getTheme();

function getTheme(): Promise<IReportTheme>

Retours

Promise<IReportTheme>

getZoom()

Retourne le niveau de zoom actuel du rapport.

function getZoom(): Promise<number>

Retours

Promise<number>

isSaved()

vérifie si le rapport est enregistré.

report.isSaved()

function isSaved(): Promise<boolean>

Retours

Promise<boolean>

moveVisual(string, string, number, number, number)

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

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

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

Paramètres

pageName: string

visualName: string

x: number

y: number

z: number

Retours

Promise<IHttpPostMessageResponse<void>>

print()

Imprime la page active du rapport en appelant window.print() sur le composant iframe incorporé.

function print(): Promise<void>

Retours

Promise<void>

refresh()

Actualise les sources de données du rapport.

report.refresh();

function refresh(): Promise<void>

Retours

Promise<void>

removeContextMenuCommand(string, string)

Supprimer la commande d’extension de menu contextuel.

report.removeContextMenuCommand(commandName, contextMenuTitle)
 .catch(error => {
     ...
 });

function removeContextMenuCommand(commandName: string, contextMenuTitle: string): Promise<IHttpPostMessageResponse<void>>

Paramètres

commandName: string

contextMenuTitle: string

Retours

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Supprime tous les filtres au niveau du rapport.

report.removeFilters();

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

Retours

Promise<IHttpPostMessageResponse<void>>

removeOptionsMenuCommand(string, string)

Supprimer la commande d’extension de menu Options.

report.removeOptionsMenuCommand(commandName, optionsMenuTitle)
 .then({
     ...
 });

function removeOptionsMenuCommand(commandName: string, optionsMenuTitle: string): Promise<IHttpPostMessageResponse<void>>

Paramètres

commandName: string

optionsMenuTitle: string

Retours

Promise<IHttpPostMessageResponse<void>>

renamePage(string, string)

Renommer une page à partir d’un rapport

// Rename a page from a report by changing displayName (pageName is different from the display name and can be acquired from the getPages API)
report.renamePage("ReportSection145", "Sales");

function renamePage(pageName: string, displayName: string): Promise<void>

Paramètres

pageName: string

displayName: string

Retours

Promise<void>

render(IReportEmbedConfiguration | IReportLoadConfiguration)

Afficher un rapport préchargé à l’aide de l’API d’incorporation par phases

// Load report
var report = powerbi.load(element, config);

...

// Render report
report.render()

function render(config?: IReportEmbedConfiguration | IReportLoadConfiguration): Promise<void>

Paramètres

config: IReportEmbedConfiguration | IReportLoadConfiguration

Retours

Promise<void>

resetPersistentFilters()

Réinitialiser les filtres, segments et autres vues de données de l’utilisateur changent à l’état par défaut du rapport

report.resetPersistentFilters();

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

Retours

Promise<IHttpPostMessageResponse<void>>

resetTheme()

Réinitialiser et appliquer le thème par défaut du rapport

report.resetTheme();

function resetTheme(): Promise<void>

Retours

Promise<void>

resizeActivePage(PageSizeType, number, number)

Met à jour la taille de la page active dans le rapport.

report.resizeActivePage(pageSizeType, width, height)
  .catch(error => { ... });

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

Paramètres

pageSizeType: PageSizeType

width: number

height: number

Retours

Promise<IHttpPostMessageResponse<void>>

resizeVisual(string, string, number, number)

Redimensionnez un visuel dans une page.

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

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

Paramètres

pageName: string

visualName: string

width: number

height: number

Retours

Promise<IHttpPostMessageResponse<void>>

savePersistentFilters()

Enregistrer les filtres, segments et autres modifications d’affichage des données de l’utilisateur du rapport

report.savePersistentFilters();

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

Retours

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Définit des filtres au niveau du rapport.

const filters: [
   ...
];

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

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

Paramètres

filters: IFilter[]

Retours

Promise<IHttpPostMessageResponse<void>>

setPage(string)

Définit la page active du rapport.

report.setPage("page2")
 .catch(error => { ... });

function setPage(pageName: string): Promise<IHttpPostMessageResponse<void>>

Paramètres

pageName: string

Retours

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(string, string, VisualContainerDisplayMode)

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

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

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

Paramètres

pageName: string

visualName: string

displayState: VisualContainerDisplayMode

Retours

Promise<IHttpPostMessageResponse<void>>

setZoom(number)

Définit le niveau de zoom du rapport.

function setZoom(zoomLevel: number): Promise<void>

Paramètres

zoomLevel: number

niveau de zoom à définir

Retours

Promise<void>

switchLayout(LayoutType)

Met à jour la disposition du rapport

report.switchLayout(layoutType);

function switchLayout(layoutType: LayoutType): Promise<IHttpPostMessageResponse<void>>

Paramètres

layoutType: LayoutType

Retours

Promise<IHttpPostMessageResponse<void>>

switchMode(string | ViewMode)

Changer le mode d’affichage Rapport.

function switchMode(viewMode: string | ViewMode): Promise<void>

Paramètres

viewMode: string | ViewMode

Retours

Promise<void>

updateFilters(FiltersOperations, IFilter[])

Mettez à jour les filtres au niveau du rapport en fonction de l’opération : Ajoutez, remplacez tout, remplacez par cible ou supprimez.

report.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>>

updateSettings(ISettings)

Met à jour les paramètres de visibilité pour le volet de filtre et le volet de navigation de page.

const newSettings = {
  panes: {
    filters: {
      visible: false
    }
  }
};

report.updateSettings(newSettings)
  .catch(error => { ... });

function updateSettings(settings: ISettings): Promise<IHttpPostMessageResponse<void>>

Paramètres

settings: ISettings

Retours

Promise<IHttpPostMessageResponse<void>>

Détails de la méthode héritée

exitFullscreen()

Demande au navigateur de quitter le mode plein écran.

function exitFullscreen()

héritée de Embed.exitFullscreen

fullscreen()

Demande au navigateur d’afficher l’iframe du composant en mode plein écran.

function fullscreen()

héritée de Embed.fullscreen

getCorrelationId()

Obtenez l’ID de corrélation pour la session incorporée actuelle.

// Get the correlationId for the current embed session
report.getCorrelationId()
  .then(correlationId => {
    ...
  });

function getCorrelationId(): Promise<string>

Retours

Promise<string>

héritée de Embed.getCorrelationId

off<T>(string, IEventHandler<T>)

Supprime un ou plusieurs gestionnaires d’événements de la liste des gestionnaires. Si une référence à la fonction de handle existante est spécifiée, supprimez le gestionnaire spécifique. Si le gestionnaire n’est pas spécifié, supprimez tous les gestionnaires pour le nom d’événement spécifié.

report.off('pageChanged')

or

const logHandler = function (event) {
   console.log(event);
};

report.off('pageChanged', logHandler);

function off<T>(eventName: string, handler?: IEventHandler<T>)

Paramètres

eventName: string

handler: IEventHandler<T>

héritée de Embed.off

on<T>(string, IEventHandler<T>)

Ajoute un gestionnaire d’événements pour un événement spécifique.

report.on('pageChanged', (event) => {
  console.log('PageChanged: ', event.page.name);
});

function on<T>(eventName: string, handler: IEventHandler<T>)

Paramètres

eventName: string

handler: IEventHandler<T>

héritée de Embed.on

reload()

Recharge l’incorporation à l’aide de la configuration existante. Par exemple, pour les rapports, cela efface efficacement tous les filtres et active la première page qui simule la réinitialisation d’un rapport à l’état chargé.

report.reload();

function reload(): Promise<void>

Retours

Promise<void>

héritée de Embed.reload

removeComponentTabIndex(number)

Supprime l’attribut tabindex de l’élément

function removeComponentTabIndex(_tabIndex?: number)

Paramètres

_tabIndex: number

héritée de Embed.removeComponentTabIndex

save()

Enregistre le rapport.

function save(): Promise<void>

Retours

Promise<void>

héritée de Embed.save

saveAs(ISaveAsParameters)

Rapport SaveAs.

function saveAs(saveAsParameters: ISaveAsParameters): Promise<void>

Paramètres

saveAsParameters: ISaveAsParameters

Retours

Promise<void>

héritée de Embed.saveAs

setAccessToken(string)

Définissez accessToken.

function setAccessToken(accessToken: string): Promise<void>

Paramètres

accessToken: string

Retours

Promise<void>

héritée de Embed.setAccessToken

setComponentTabIndex(number)

Définit l’attribut tabindex de l’élément

function setComponentTabIndex(tabIndex?: number)

Paramètres

tabIndex: number

héritée de Embed.setComponentTabIndex

setComponentTitle(string)

Définissez le titre du composant pour l’accessibilité. En cas d’iframes, cette méthode modifie le titre de l’iframe.

function setComponentTitle(title: string)

Paramètres

title: string

héritée de Embed.setComponentTitle

Partager via

Report class

Propriétés

Méthodes

Méthodes héritées

Détails de la propriété

bookmarksManager

Valeur de propriété

Détails de la méthode

addContextMenuCommand(string, string, string, MenuLocation, string, string, string)

Paramètres

Retours

addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)

Paramètres

Retours

addPage(string)

Paramètres

Retours

applyTheme(IReportTheme)

Paramètres

Retours

arePersistentFiltersApplied()

Retours

clearSelectedVisuals(boolean)

Paramètres

Retours

closeAllOverlays()

Retours

configChanged(boolean)

Paramètres

deletePage(string)

Paramètres

Retours

getActivePage()

Retours

getFilters()

Retours

getId()

Retours

getPageByName(string)

Paramètres

Retours

getPages()

Retours

getTheme()

Retours

getZoom()

Retours

isSaved()

Retours

moveVisual(string, string, number, number, number)

Paramètres

Retours

print()

Retours

refresh()

Retours

removeContextMenuCommand(string, string)

Paramètres

Retours

removeFilters()

Retours

removeOptionsMenuCommand(string, string)

Paramètres

Retours

renamePage(string, string)

Paramètres

Retours

render(IReportEmbedConfiguration | IReportLoadConfiguration)

Paramètres

Retours

resetPersistentFilters()

Retours

resetTheme()

Retours

resizeActivePage(PageSizeType, number, number)

Paramètres

Retours

resizeVisual(string, string, number, number)

Paramètres