Visual class

bookmarksManager: BookmarksManager

Valeur de propriété

héritée deReport.bookmarksManager

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

Retours

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

function getPages(): Promise<Page[]>

Retours

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

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

function getVisualDescriptor(): Promise<VisualDescriptor>

Retours

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

Retours

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

Retours

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

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

Paramètres

Retours

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

Retours

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

Retours

héritée deReport.addContextMenuCommand

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

Retours

héritée deReport.addOptionsMenuCommand

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

Retours

héritée deReport.addPage

Appliquer un thème au rapport

report.applyTheme(theme);

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

Paramètres

Retours

héritée deReport.applyTheme

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

héritée deReport.arePersistentFiltersApplied

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

Retours

héritée deReport.clearSelectedVisuals

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

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

function closeAllOverlays(): Promise<void>

Retours

héritée deReport.closeAllOverlays

Gérer les modifications de configuration.

function configChanged(isBootstrap: boolean)

Paramètres

héritée deReport.configChanged

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

Retours

héritée deReport.deletePage

Demande au navigateur de quitter le mode plein écran.

function exitFullscreen()

héritée deReport.exitFullscreen

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

function fullscreen()

héritée deReport.fullscreen

Obtient la page de rapport active.

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

function getActivePage(): Promise<Page>

Retours

héritée deReport.getActivePage

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

héritée deReport.getCorrelationId

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

function getId(): string

Retours

héritée deReport.getId

Obtient une page de rapport par son nom.

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

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

Paramètres

Retours

héritée deReport.getPageByName

obtenir le thème du rapport

report.getTheme();

function getTheme(): Promise<IReportTheme>

Retours

héritée deReport.getTheme

Retourne le niveau de zoom actuel du rapport.

function getZoom(): Promise<number>

Retours

héritée deReport.getZoom

vérifie si le rapport est enregistré.

report.isSaved()

function isSaved(): Promise<boolean>

Retours

héritée deReport.isSaved

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

Retours

héritée deReport.moveVisual

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

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

function print(): Promise<void>

Retours

héritée dereport.print

Actualise les sources de données du rapport.

report.refresh();

function refresh(): Promise<void>

Retours

héritée deReport.refresh

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

héritée deReport.reload

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

function removeComponentTabIndex(_tabIndex?: number)

Paramètres

héritée deReport.removeComponentTabIndex

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

Retours

héritée deReport.removeContextMenuCommand

Supprimer la commande d’extension de menu Options.

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

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

Paramètres

Retours

héritée deReport.removeOptionsMenuCommand

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

Retours

héritée deReport.renamePage

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

héritée deReport.resetPersistentFilters

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

report.resetTheme();

function resetTheme(): Promise<void>

Retours

héritée deReport.resetTheme

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

Retours

héritée deReport.resizeActivePage

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

Retours

héritée deReport.resizeVisual

Enregistre le rapport.

function save(): Promise<void>

Retours

héritée deReport.save

Rapport SaveAs.

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

Paramètres

Retours

héritée deReport.saveAs

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

héritée deReport.savePersistentFilters

Définissez accessToken.

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

Paramètres

Retours

héritée deReport.setAccessToken

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

function setComponentTabIndex(tabIndex?: number)

Paramètres

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

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

Retours

héritée deReport.setVisualDisplayState

Définit le niveau de zoom du rapport.

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

Paramètres

Retours

héritée deReport.setZoom

Met à jour la disposition du rapport

report.switchLayout(layoutType);

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

Paramètres

Retours

héritée deReport.switchLayout

Changer le mode d’affichage Rapport.

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

Paramètres

Retours

héritée deReport.switchMode

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

Retours

héritée deReport.updateSettings