Report class

bookmarksManager: BookmarksManager

Valeur de la propriété

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

Retourne

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

Retourne

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

Retourne

Appliquer un thème au rapport

report.applyTheme(theme);

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

Paramètres

Retourne

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>

Retourne

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

Retourne

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

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

function closeAllOverlays(): Promise<void>

Retourne

Gérer les modifications de configuration.

function configChanged(isBootstrap: boolean)

Paramètres

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

Retourne

Obtient la page de rapport active.

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

function getActivePage(): Promise<Page>

Retourne

Obtient les filtres appliqués au niveau du rapport.

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

function getFilters(): Promise<IFilter[]>

Retourne

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

function getId(): string

Retourne

Obtient une page de rapport par son nom.

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

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

Paramètres

Retourne

Obtient la liste des pages du rapport.

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

function getPages(): Promise<Page[]>

Retourne

obtenir le thème du rapport

report.getTheme();

function getTheme(): Promise<IReportTheme>

Retourne

Retourne le niveau de zoom actuel du rapport.

function getZoom(): Promise<number>

Retourne

vérifie si le rapport est enregistré.

report.isSaved()

function isSaved(): Promise<boolean>

Retourne

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

Retourne

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

function print(): Promise<void>

Retourne

Actualise les sources de données du rapport.

report.refresh();

function refresh(): Promise<void>

Retourne

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

Retourne

Supprime tous les filtres au niveau du rapport.

report.removeFilters();

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

Retourne

Supprimer la commande d’extension de menu Options.

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

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

Paramètres

Retourne

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

Retourne

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

Retourne

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

Retourne

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

report.resetTheme();

function resetTheme(): Promise<void>

Retourne

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

Retourne

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

Retourne

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

report.savePersistentFilters();

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

Retourne

Définit des filtres au niveau du rapport.

const filters: [
   ...
];

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

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

Paramètres

Retourne

Définit la page active du rapport.

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

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

Paramètres

Retourne

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

Retourne

Définit le niveau de zoom du rapport.

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

Paramètres

Retourne

Met à jour la disposition du rapport

report.switchLayout(layoutType);

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

Paramètres

Retourne

Changer le mode d’affichage Rapport.

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

Paramètres

Retourne

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

Retourne

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

Retourne

Demande au navigateur de quitter le mode plein écran.

function exitFullscreen()

héritée de Embed.exitFullscreen

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

function fullscreen()

héritée de Embed.fullscreen

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>

Retourne

héritée de Embed.getCorrelationId

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

héritée de Embed.off

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

héritée de Embed.on

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>

Retourne

héritée de Embed.reload

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

function removeComponentTabIndex(_tabIndex?: number)

Paramètres

héritée de Embed.removeComponentTabIndex

Enregistre le rapport.

function save(): Promise<void>

Retourne

héritée de Embed.save

Rapport SaveAs.

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

Paramètres

Retourne

héritée de Embed.saveAs

Définissez accessToken.

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

Paramètres

Retourne

héritée de Embed.setAccessToken

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

function setComponentTabIndex(tabIndex?: number)

Paramètres

héritée de Embed.setComponentTabIndex

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

héritée de Embed.setComponentTitle