Partager via


Visual class

Composant d’incorporation visuelle Power BI

Extends

Propriétés héritées

bookmarksManager

Méthodes

getFilters(FiltersLevel)

Obtient les filtres appliqués au niveau du filtre. Le niveau de filtre par défaut est le niveau visuel.

visual.getFilters(filtersLevel)
  .then(filters => {
    ...
  });
getPages()

Obtient la liste des pages dans le rapport , non prise en charge dans le visuel

getVisualDescriptor()

Obtient l’objet de descripteur visuel incorporé qui contient le nom visuel, le type, etc.

visual.getVisualDescriptor()
  .then(visualDetails => { ... });
removeFilters(FiltersLevel)

Supprime tous les filtres du niveau de filtre actuel. Le niveau de filtre par défaut est le niveau visuel.

visual.removeFilters(filtersLevel);
setFilters(IFilter[], FiltersLevel)

Définit des filtres au niveau du filtre. Le niveau de filtre par défaut est le niveau visuel.

const filters: [
   ...
];

visual.setFilters(filters, filtersLevel)
 .catch(errors => {
   ...
 });
setPage(string)

Définit la page active du rapport - non prise en charge dans le visuel

updateFilters(FiltersOperations, IFilter[], FiltersLevel)

Met à jour les filtres au niveau du filtre. Le niveau de filtre par défaut est le niveau visuel.

const filters: [
   ...
];

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

Méthodes héritées

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");
exitFullscreen()

Demande au navigateur de quitter le mode plein écran.

fullscreen()

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

getActivePage()

Obtient la page de rapport active.

report.getActivePage()
 .then(activePage => {
     ...
 });
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 => {
    ...
  });
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 => {
     ...
 });
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 => { ... });
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);
});
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();
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

removeContextMenuCommand(string, string)

Supprimer la commande d’extension de menu contextuel.

report.removeContextMenuCommand(commandName, contextMenuTitle)
 .catch(error => {
     ...
 });
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");
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 => { ... });
save()

Enregistre le rapport.

saveAs(ISaveAsParameters)

Rapport SaveAs.

savePersistentFilters()

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

report.savePersistentFilters();
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.

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.

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 => { ... });

Détails de la propriété héritée

bookmarksManager

bookmarksManager: BookmarksManager

Valeur de propriété

héritée deReport.bookmarksManager

Détails de la méthode

getFilters(FiltersLevel)

Obtient les filtres appliqués au niveau du filtre. Le niveau de filtre par défaut est le niveau visuel.

visual.getFilters(filtersLevel)
  .then(filters => {
    ...
  });
function getFilters(filtersLevel?: FiltersLevel): Promise<IFilter[]>

Paramètres

filtersLevel
FiltersLevel

Retours

Promise<IFilter[]>

getPages()

Obtient la liste des pages dans le rapport , non prise en charge dans le visuel

function getPages(): Promise<Page[]>

Retours

Promise<Page[]>

getVisualDescriptor()

Obtient l’objet de descripteur visuel incorporé qui contient le nom visuel, le type, etc.

visual.getVisualDescriptor()
  .then(visualDetails => { ... });
function getVisualDescriptor(): Promise<VisualDescriptor>

Retours

Promise<VisualDescriptor>

removeFilters(FiltersLevel)

Supprime tous les filtres du niveau de filtre actuel. Le niveau de filtre par défaut est le niveau visuel.

visual.removeFilters(filtersLevel);
function removeFilters(filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>

Paramètres

filtersLevel
FiltersLevel

Retours

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[], FiltersLevel)

Définit des filtres au niveau du filtre. Le niveau de filtre par défaut est le niveau visuel.

const filters: [
   ...
];

visual.setFilters(filters, filtersLevel)
 .catch(errors => {
   ...
 });
function setFilters(filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>

Paramètres

filters

IFilter[]

filtersLevel
FiltersLevel

Retours

Promise<IHttpPostMessageResponse<void>>

setPage(string)

Définit la page active du rapport - non prise en charge dans le visuel

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

Paramètres

_pageName

string

Retours

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[], FiltersLevel)

Met à jour les filtres au niveau du filtre. Le niveau de filtre par défaut est le niveau visuel.

const filters: [
   ...
];

visual.updateFilters(FiltersOperations.Add, filters, filtersLevel)
 .catch(errors => {
   ...
 });
function updateFilters(operation: FiltersOperations, filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>

Paramètres

operation
FiltersOperations
filters

IFilter[]

filtersLevel
FiltersLevel

Retours

Promise<IHttpPostMessageResponse<void>>

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

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

héritée deReport.addContextMenuCommand

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

héritée deReport.addOptionsMenuCommand

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>

héritée deReport.addPage

applyTheme(IReportTheme)

Appliquer un thème au rapport

report.applyTheme(theme);
function applyTheme(theme: IReportTheme): Promise<void>

Paramètres

theme
IReportTheme

Retours

Promise<void>

héritée deReport.applyTheme

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>

héritée deReport.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(() => {
     ...
 });
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>

héritée deReport.clearSelectedVisuals

closeAllOverlays()

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

report.closeAllOverlays()
 .then(() => {
     ...
 });
function closeAllOverlays(): Promise<void>

Retours

Promise<void>

héritée deReport.closeAllOverlays

configChanged(boolean)

Gérer les modifications de configuration.

function configChanged(isBootstrap: boolean)

Paramètres

isBootstrap

boolean

héritée deReport.configChanged

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>

héritée deReport.deletePage

exitFullscreen()

Demande au navigateur de quitter le mode plein écran.

function exitFullscreen()

héritée deReport.exitFullscreen

fullscreen()

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

function fullscreen()

héritée deReport.fullscreen

getActivePage()

Obtient la page de rapport active.

report.getActivePage()
 .then(activePage => {
     ...
 });
function getActivePage(): Promise<Page>

Retours

Promise<Page>

héritée deReport.getActivePage

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 deReport.getCorrelationId

getId()

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

function getId(): string

Retours

string

héritée deReport.getId

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>

héritée deReport.getPageByName

getTheme()

obtenir le thème du rapport

report.getTheme();
function getTheme(): Promise<IReportTheme>

Retours

Promise<IReportTheme>

héritée deReport.getTheme

getZoom()

Retourne le niveau de zoom actuel du rapport.

function getZoom(): Promise<number>

Retours

Promise<number>

héritée deReport.getZoom

isSaved()

vérifie si le rapport est enregistré.

report.isSaved()
function isSaved(): Promise<boolean>

Retours

Promise<boolean>

héritée deReport.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 => { ... });
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>>

héritée deReport.moveVisual

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 deReport.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 deReport.on

print()

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

function print(): Promise<void>

Retours

Promise<void>

héritée dereport.print

refresh()

Actualise les sources de données du rapport.

report.refresh();
function refresh(): Promise<void>

Retours

Promise<void>

héritée deReport.refresh

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 deReport.reload

removeComponentTabIndex(number)

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

function removeComponentTabIndex(_tabIndex?: number)

Paramètres

_tabIndex

number

héritée deReport.removeComponentTabIndex

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

héritée deReport.removeContextMenuCommand

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

héritée deReport.removeOptionsMenuCommand

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>

héritée deReport.renamePage

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

héritée deReport.resetPersistentFilters

resetTheme()

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

report.resetTheme();
function resetTheme(): Promise<void>

Retours

Promise<void>

héritée deReport.resetTheme

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

héritée deReport.resizeActivePage

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

héritée deReport.resizeVisual

save()

Enregistre le rapport.

function save(): Promise<void>

Retours

Promise<void>

héritée deReport.save

saveAs(ISaveAsParameters)

Rapport SaveAs.

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

Paramètres

saveAsParameters
ISaveAsParameters

Retours

Promise<void>

héritée deReport.saveAs

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

héritée deReport.savePersistentFilters

setAccessToken(string)

Définissez accessToken.

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

Paramètres

accessToken

string

Retours

Promise<void>

héritée deReport.setAccessToken

setComponentTabIndex(number)

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

function setComponentTabIndex(tabIndex?: number)

Paramètres

tabIndex

number

héritée deReport.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 deReport.setComponentTitle

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

Retours

Promise<IHttpPostMessageResponse<void>>

héritée deReport.setVisualDisplayState

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>

héritée deReport.setZoom

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

héritée deReport.switchLayout

switchMode(string | ViewMode)

Changer le mode d’affichage Rapport.

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

Paramètres

viewMode

string | ViewMode

Retours

Promise<void>

héritée deReport.switchMode

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

héritée deReport.updateSettings