Report class

bookmarksManager: BookmarksManager

Valore della proprietà

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

Valori restituiti

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

Valori restituiti

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

Valori restituiti

Applicare un tema al report

report.applyTheme(theme);

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

Parametri

Valori restituiti

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>

Valori restituiti

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

Valori restituiti

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

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

function closeAllOverlays(): Promise<void>

Valori restituiti

Gestire le modifiche alla configurazione.

function configChanged(isBootstrap: boolean)

Parametri

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

Valori restituiti

Ottiene la pagina del report attiva.

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

function getActivePage(): Promise<Page>

Valori restituiti

Ottiene i filtri applicati a livello di report.

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

function getFilters(): Promise<IFilter[]>

Valori restituiti

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

function getId(): string

Valori restituiti

Ottiene una pagina del report in base al nome.

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

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

Parametri

Valori restituiti

Ottiene l'elenco di pagine all'interno del report.

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

function getPages(): Promise<Page[]>

Valori restituiti

ottenere il tema del report

report.getTheme();

function getTheme(): Promise<IReportTheme>

Valori restituiti

Restituisce il livello di zoom corrente del report.

function getZoom(): Promise<number>

Valori restituiti

controlla se il report viene salvato.

report.isSaved()

function isSaved(): Promise<boolean>

Valori restituiti

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

Valori restituiti

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

function print(): Promise<void>

Valori restituiti

Aggiorna le origini dati per il report.

report.refresh();

function refresh(): Promise<void>

Valori restituiti

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

Valori restituiti

Rimuove tutti i filtri a livello di report.

report.removeFilters();

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

Valori restituiti

Comando Rimuovi l'estensione del menu Opzioni.

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

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

Parametri

Valori restituiti

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

Valori restituiti

Eseguire il rendering di un report precaricato usando l'API di incorporamento in più fasi

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

...

// Render report
report.render()

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

Parametri

Valori restituiti

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

Valori restituiti

Reimpostare e applicare il tema predefinito del report

report.resetTheme();

function resetTheme(): Promise<void>

Valori restituiti

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

Valori restituiti

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

Valori restituiti

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

report.savePersistentFilters();

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

Valori restituiti

Imposta i filtri a livello di report.

const filters: [
   ...
];

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

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

Parametri

Valori restituiti

Imposta la pagina attiva del report.

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

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

Parametri

Valori restituiti

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

Valori restituiti

Imposta il livello di zoom del report.

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

Parametri

Valori restituiti

Aggiorna il layout del report

report.switchLayout(layoutType);

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

Parametri

Valori restituiti

Cambiare la modalità visualizzazione report.

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

Parametri

Valori restituiti

Aggiornare i filtri a livello di report in base all'operazione: aggiungere, sostituire tutto, sostituire per destinazione o rimuovere.

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

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

Parametri

Valori restituiti

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

Valori restituiti

Richiede al browser di uscire dalla modalità schermo intero.

function exitFullscreen()

Ereditato da Embed.exitFullscreen

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

function fullscreen()

ereditato da Embed.fullscreen

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>

Valori restituiti

Ereditato da Embed.getCorrelationId

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 da Embed.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 da Embed.on

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>

Valori restituiti

Ereditato da Embed.reload

Rimuove l'attributo tabindex dell'elemento

function removeComponentTabIndex(_tabIndex?: number)

Parametri

Ereditato da Embed.removeComponentTabIndex

Salva report.

function save(): Promise<void>

Valori restituiti

Ereditato da Embed.save

SaveAs Report.

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

Parametri

Valori restituiti

Ereditato da Embed.saveAs

Impostare accessToken.

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

Parametri

Valori restituiti

Ereditato da Embed.setAccessToken

Imposta l'attributo tabindex dell'elemento

function setComponentTabIndex(tabIndex?: number)

Parametri

Ereditato da Embed.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 da Embed.setComponentTitle