Visual class

bookmarksManager: BookmarksManager

Valore della proprietà

ereditato daReport.bookmarksManager

Ottiene i filtri applicati al livello di filtro. Il livello di filtro predefinito è a livello di oggetto visivo.

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

function getFilters(filtersLevel?: FiltersLevel): Promise<IFilter[]>

Parametri

Restituisce

Ottiene l'elenco di pagine all'interno del report, non supportato nell'oggetto visivo

function getPages(): Promise<Page[]>

Restituisce

Ottiene l'oggetto descrittore visivo incorporato che contiene il nome dell'oggetto visivo, il tipo e così via.

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

function getVisualDescriptor(): Promise<VisualDescriptor>

Restituisce

Rimuove tutti i filtri dal livello di filtro corrente. Il livello di filtro predefinito è a livello di oggetto visivo.

visual.removeFilters(filtersLevel);

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

Parametri

Restituisce

Imposta i filtri a livello di filtro. Il livello di filtro predefinito è a livello di oggetto visivo.

const filters: [
   ...
];

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

function setFilters(filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>

Parametri

Restituisce

Imposta la pagina attiva del report, non supportata nell'oggetto visivo

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

Parametri

Restituisce

Aggiorna i filtri a livello di filtro. Il livello di filtro predefinito è a livello di oggetto visivo.

const filters: [
   ...
];

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

function updateFilters(operation: FiltersOperations, filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>

Parametri

Restituisce

Aggiungere il comando di estensione del menu di scelta rapida.

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

Parametri

Restituisce

Ereditato daReport.addContextMenuCommand

Comando Aggiungi estensione del menu Opzioni.

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

Parametri

Restituisce

Ereditato daReport.addOptionsMenuCommand

Aggiungere una pagina vuota al report

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

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

Parametri

Restituisce

Ereditato daReport.addPage

Applicare un tema al report

report.applyTheme(theme);

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

Parametri

Restituisce

Ereditato daReport.applyTheme

Restituisce se sono presenti filtri, filtri dei dati o altre modifiche alla visualizzazione dati applicate al report. Se i filtri permanenti vengono disabilitati, restituisce false.

report.arePersistentFiltersApplied();

function arePersistentFiltersApplied(): Promise<boolean>

Restituisce

Ereditato daReport.arePersistentFiltersApplied

Cancella gli oggetti visivi selezionati non visualizzati, se viene passato il flag, tutte le selezioni degli oggetti visivi verranno cancellate.

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

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

Parametri

Restituisce

ereditato daReport.clearSelectedVisuals

Chiude tutti i menu di scelta rapida aperti e le descrizioni comando.

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

function closeAllOverlays(): Promise<void>

Restituisce

ereditato daReport.closeAllOverlays

Gestire le modifiche alla configurazione.

function configChanged(isBootstrap: boolean)

Parametri

ereditato daReport.configChanged

Eliminare una pagina da un report

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

Parametri

Restituisce

ereditato daReport.deletePage

Richiede al browser di uscire dalla modalità schermo intero.

function exitFullscreen()

Ereditato daReport.exitFullscreen

Richiede al browser di eseguire il rendering dell'iframe del componente in modalità schermo intero.

function fullscreen()

ereditato daReport.fullscreen

Ottiene la pagina del report attiva.

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

function getActivePage(): Promise<Page>

Restituisce

ereditato daReport.getActivePage

Ottenere il correlationId per la sessione di incorporamento corrente.

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

function getCorrelationId(): Promise<string>

Restituisce

ereditato daReport.getCorrelationId

Ottiene l'ID del report dal primo percorso disponibile: opzioni, attributo, URL di incorporamento.

function getId(): string

Restituisce

ereditato daReport.getId

Ottiene una pagina del report in base al nome.

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

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

Parametri

Restituisce

Ereditato daReport.getPageByName

ottenere il tema del report

report.getTheme();

function getTheme(): Promise<IReportTheme>

Restituisce

Ereditato daReport.getTheme

Restituisce il livello di zoom corrente del report.

function getZoom(): Promise<number>

Restituisce

ereditato daReport.getZoom

controlla se il report viene salvato.

report.isSaved()

function isSaved(): Promise<boolean>

Restituisce

Ereditato daReport.isSaved

Aggiorna la posizione di un oggetto visivo in una pagina.

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

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

Parametri

Restituisce

Ereditato daReport.moveVisual

Rimuove uno o più gestori eventi dall'elenco dei gestori. Se viene specificato un riferimento alla funzione handle esistente, rimuovere il gestore specifico. Se il gestore non è specificato, rimuovere tutti i gestori per il nome dell'evento specificato.

report.off('pageChanged')

or

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

report.off('pageChanged', logHandler);

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

Parametri

ereditato daReport.off

Aggiunge un gestore eventi per un evento specifico.

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

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

Parametri

ereditato daReport.on

Stampa la pagina attiva del report richiamando window.print() nel componente iframe di incorporamento.

function print(): Promise<void>

Restituisce

ereditato daReport.print

Aggiorna le origini dati per il report.

report.refresh();

function refresh(): Promise<void>

Restituisce

ereditato daReport.refresh

Ricarica l'incorporamento usando la configurazione esistente. Ad esempio, per i report questo cancella efficacemente tutti i filtri e rende attiva la prima pagina che simula la reimpostazione di un report sullo stato caricato.

report.reload();

function reload(): Promise<void>

Restituisce

ereditato daReport.reload

Rimuove l'attributo tabindex dell'elemento

function removeComponentTabIndex(_tabIndex?: number)

Parametri

Ereditato daReport.removeComponentTabIndex

Rimuovere il comando di estensione del menu di scelta rapida.

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

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

Parametri

Restituisce

ereditato daReport.removeContextMenuCommand

Comando Rimuovi l'estensione del menu Opzioni.

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

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

Parametri

Restituisce

Ereditato daReport.removeOptionsMenuCommand

Rinominare una pagina da un report

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

Parametri

Restituisce

Ereditato daReport.renamePage

Reimpostare i filtri, i filtri dei dati e altre modifiche della visualizzazione dati dell'utente allo stato predefinito del report

report.resetPersistentFilters();

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

Restituisce

Ereditato daReport.resetPersistentFilters

Reimpostare e applicare il tema predefinito del report

report.resetTheme();

function resetTheme(): Promise<void>

Restituisce

Ereditato daReport.resetTheme

Aggiorna le dimensioni della pagina attiva nel report.

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

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

Parametri

Restituisce

Ereditato daReport.resizeActivePage

Ridimensionare un oggetto visivo in una pagina.

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

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

Parametri

Restituisce

Ereditato daReport.resizeVisual

Salva report.

function save(): Promise<void>

Restituisce

Ereditato daReport.save

SaveAs Report.

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

Parametri

Restituisce

ereditato daReport.saveAs

Salvare filtri, filtri dei dati e altre modifiche alla visualizzazione dati del report

report.savePersistentFilters();

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

Restituisce

Ereditato daReport.savePersistentFilters

Impostare accessToken.

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

Parametri

Restituisce

Ereditato daReport.setAccessToken

Imposta l'attributo tabindex dell'elemento

function setComponentTabIndex(tabIndex?: number)

Parametri

Ereditato daReport.setComponentTabIndex

Impostare il titolo del componente per l'accessibilità. In caso di iframe, questo metodo modificherà il titolo dell'iframe.

function setComponentTitle(title: string)

Parametri

Ereditato daReport.setComponentTitle

Aggiorna lo stato di visualizzazione di un oggetto visivo in una pagina.

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

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

Parametri

Restituisce

Ereditato daReport.setVisualDisplayState

Imposta il livello di zoom del report.

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

Parametri

Restituisce

Ereditato daReport.setZoom

Aggiorna il layout del report

report.switchLayout(layoutType);

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

Parametri

Restituisce

ereditato daReport.switchLayout

Cambiare la modalità visualizzazione report.

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

Parametri

Restituisce

Ereditato daReport.switchMode

Aggiorna le impostazioni di visibilità per il riquadro filtro e il riquadro di spostamento della pagina.

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

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

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

Parametri

Restituisce

ereditato daReport.updateSettings