Report class

Pacchetto:

powerbi-client

Componente di incorporamento del report di Power BI

Extends

Embed

Proprietà

bookmarksManager

Metodi

addContextMenuCommand(string, string, string, MenuLocation, string, string, string)	Aggiungere il comando di estensione del menu di scelta rapida. report.addContextMenuCommand(commandName, commandTitle, contextMenuTitle, menuLocation, visualName, visualType, groupName) .catch(error => { ... });
addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)	Comando Di estensione del menu Aggiungi opzioni. report.addOptionsMenuCommand(commandName, commandTitle, optionsMenuTitle, menuLocation, visualName, visualType, groupName, commandIcon) .catch(error => { ... });
addPage(string)	Aggiungere una pagina vuota al report // Add a page to the report with "Sales" as the page display name report.addPage("Sales");
applyTheme(IReportTheme)	Applicare un tema al report report.applyTheme(theme);
arePersistentFiltersApplied()	Restituisce se sono presenti filtri, filtri dei dati o altre modifiche della visualizzazione dati applicate al report. Se i filtri persistenti vengono disabilitati, restituisce false. report.arePersistentFiltersApplied();
clearSelectedVisuals(boolean)	Cancella gli oggetti visivi selezionati non visualizzati, se viene passato il flag, tutte le selezioni degli oggetti visivi verranno cancellate. report.clearSelectedVisuals() .then(() => { ... });
closeAllOverlays()	Chiude tutti i menu di scelta rapida aperti e le descrizioni comando. report.closeAllOverlays() .then(() => { ... });
configChanged(boolean)	Gestire le modifiche di configurazione.
deletePage(string)	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");
getActivePage()	Ottiene la pagina del report attiva. report.getActivePage() .then(activePage => { ... });
getFilters()	Ottiene i filtri applicati a livello di report. // Get filters applied at report level report.getFilters() .then(filters => { ... });
getId()	Ottiene l'ID del report dal primo percorso disponibile: opzioni, attributo, URL di incorporamento.
getPageByName(string)	Ottiene una pagina del report in base al nome. report.getPageByName(pageName) .then(page => { ... });
getPages()	Ottiene l'elenco di pagine all'interno del report. report.getPages() .then(pages => { ... });
getTheme()	ottenere il tema del report report.getTheme();
getZoom()	Restituisce il livello di zoom corrente del report.
isSaved()	controlla se il report viene salvato. report.isSaved()
moveVisual(string, string, number, number, number)	Aggiornamenti la posizione di un oggetto visivo in una pagina. report.moveVisual(pageName, visualName, x, y, z) .catch(error => { ... });
print()	Stampa la pagina attiva del report richiamando window.print() il componente iframe di incorporamento.
refresh()	Aggiorna le origini dati per il report. report.refresh();
removeContextMenuCommand(string, string)	Rimuovere il comando di estensione del menu di scelta rapida. report.removeContextMenuCommand(commandName, contextMenuTitle) .catch(error => { ... });
removeFilters()	Rimuove tutti i filtri a livello di report. report.removeFilters();
removeOptionsMenuCommand(string, string)	Comando Di estensione del menu Rimuovi opzioni. report.removeOptionsMenuCommand(commandName, optionsMenuTitle) .then({ ... });
renamePage(string, string)	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");
render(IReportEmbedConfiguration | IReportLoadConfiguration)	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()
resetPersistentFilters()	Reimpostare i filtri, i filtri dei dati e altre modifiche della visualizzazione dati dell'utente allo stato predefinito del report report.resetPersistentFilters();
resetTheme()	Reimpostare e applicare il tema predefinito del report report.resetTheme();
resizeActivePage(PageSizeType, number, number)	Aggiornamenti le dimensioni della pagina attiva nel report. report.resizeActivePage(pageSizeType, width, height) .catch(error => { ... });
resizeVisual(string, string, number, number)	Ridimensionare un oggetto visivo in una pagina. report.resizeVisual(pageName, visualName, width, height) .catch(error => { ... });
savePersistentFilters()	Salvare i filtri, i filtri dei dati e altre modifiche della visualizzazione dati del report report.savePersistentFilters();
setFilters(IFilter[])	Imposta i filtri a livello di report. const filters: [ ... ]; report.setFilters(filters) .catch(errors => { ... });
setPage(string)	Imposta la pagina attiva del report. report.setPage("page2") .catch(error => { ... });
setVisualDisplayState(string, string, VisualContainerDisplayMode)	Aggiornamenti lo stato di visualizzazione di un oggetto visivo in una pagina. report.setVisualDisplayState(pageName, visualName, displayState) .catch(error => { ... });
setZoom(number)	Imposta il livello di zoom del report.
switchLayout(LayoutType)	Aggiornamenti il layout del report report.switchLayout(layoutType);
switchMode(string | ViewMode)	Cambiare la modalità di visualizzazione report.
updateFilters(FiltersOperations, IFilter[])	Aggiornare i filtri a livello di report in base all'operazione: aggiungere, sostituire tutti, sostituire per destinazione o rimuovere. report.updateFilters(FiltersOperations.Add, filters) .catch(errors => { ... });
updateSettings(ISettings)	Aggiornamenti 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 => { ... });

Metodi ereditati

exitFullscreen()	Richiede al browser di uscire dalla modalità schermo intero.
fullscreen()	Richiede al browser di eseguire il rendering dell'iframe del componente in modalità schermo intero.
getCorrelationId()	Ottiene il correlationId per la sessione di incorporamento corrente. // Get the correlationId for the current embed session report.getCorrelationId() .then(correlationId => { ... });
off<T>(string, IEventHandler<T>)	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);
on<T>(string, IEventHandler<T>)	Aggiunge un gestore eventi per un evento specifico. report.on('pageChanged', (event) => { console.log('PageChanged: ', event.page.name); });
reload()	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 in stato caricato. report.reload();
removeComponentTabIndex(number)	Rimuove l'attributo tabindex dell'elemento
save()	Salva report.
saveAs(ISaveAsParameters)	SaveAs Report.
setAccessToken(string)	Impostare accessToken.
setComponentTabIndex(number)	Imposta l'attributo tabindex dell'elemento
setComponentTitle(string)	Impostare il titolo del componente per l'accessibilità. In caso di iframe, questo metodo modificherà il titolo dell'iframe.

Dettagli proprietà

bookmarksManager

bookmarksManager: BookmarksManager

Valore della proprietà

BookmarksManager

Dettagli metodo

addContextMenuCommand(string, string, string, MenuLocation, string, string, string)

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

commandName

string

commandTitle

string

contextMenuTitle

string

menuLocation

MenuLocation

visualName

string

visualType

string

groupName

string

Restituisce

Promise<IHttpPostMessageResponse<void>>

addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)

Comando Di estensione del menu Aggiungi 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

commandName

string

commandTitle

string

optionsMenuTitle

string

menuLocation

MenuLocation

visualName

string

visualType

string

groupName

string

commandIcon

string

Restituisce

Promise<IHttpPostMessageResponse<void>>

addPage(string)

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

displayName

string

Restituisce

Promise<Page>

applyTheme(IReportTheme)

Applicare un tema al report

report.applyTheme(theme);

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

Parametri

theme

IReportTheme

Restituisce

Promise<void>

arePersistentFiltersApplied()

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

report.arePersistentFiltersApplied();

function arePersistentFiltersApplied(): Promise<boolean>

Restituisce

Promise<boolean>

clearSelectedVisuals(boolean)

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

clearPopOutState

boolean

Se la selezione degli oggetti visivi false/non definita non verrà cancellata se uno degli oggetti visivi è in stato di estrazione (in stato attivo, mostra come tabella, contenuti in evidenza...)

Restituisce

Promise<void>

closeAllOverlays()

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

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

function closeAllOverlays(): Promise<void>

Restituisce

Promise<void>

configChanged(boolean)

Gestire le modifiche di configurazione.

function configChanged(isBootstrap: boolean)

Parametri

isBootstrap

boolean

deletePage(string)

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

pageName

string

Restituisce

Promise<void>

getActivePage()

Ottiene la pagina del report attiva.

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

function getActivePage(): Promise<Page>

Restituisce

Promise<Page>

getFilters()

Ottiene i filtri applicati a livello di report.

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

function getFilters(): Promise<IFilter[]>

Restituisce

Promise<IFilter[]>

getId()

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

function getId(): string

Restituisce

string

getPageByName(string)

Ottiene una pagina del report in base al nome.

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

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

Parametri

pageName

string

Restituisce

Promise<Page>

getPages()

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

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

function getPages(): Promise<Page[]>

Restituisce

Promise<Page[]>

getTheme()

ottenere il tema del report

report.getTheme();

function getTheme(): Promise<IReportTheme>

Restituisce

Promise<IReportTheme>

getZoom()

Restituisce il livello di zoom corrente del report.

function getZoom(): Promise<number>

Restituisce

Promise<number>

isSaved()

controlla se il report viene salvato.

report.isSaved()

function isSaved(): Promise<boolean>

Restituisce

Promise<boolean>

moveVisual(string, string, number, number, number)

Aggiornamenti 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

pageName

string

visualName

string

x

number

y

number

z

number

Restituisce

Promise<IHttpPostMessageResponse<void>>

print()

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

function print(): Promise<void>

Restituisce

Promise<void>

refresh()

Aggiorna le origini dati per il report.

report.refresh();

function refresh(): Promise<void>

Restituisce

Promise<void>

removeContextMenuCommand(string, string)

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

commandName

string

contextMenuTitle

string

Restituisce

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Rimuove tutti i filtri a livello di report.

report.removeFilters();

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

Restituisce

Promise<IHttpPostMessageResponse<void>>

removeOptionsMenuCommand(string, string)

Comando Di estensione del menu Rimuovi opzioni.

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

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

Parametri

commandName

string

optionsMenuTitle

string

Restituisce

Promise<IHttpPostMessageResponse<void>>

renamePage(string, string)

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

pageName

string

displayName

string

Restituisce

Promise<void>

render(IReportEmbedConfiguration | IReportLoadConfiguration)

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

config

IReportEmbedConfiguration | IReportLoadConfiguration

Restituisce

Promise<void>

resetPersistentFilters()

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

Promise<IHttpPostMessageResponse<void>>

resetTheme()

Reimpostare e applicare il tema predefinito del report

report.resetTheme();

function resetTheme(): Promise<void>

Restituisce

Promise<void>

resizeActivePage(PageSizeType, number, number)

Aggiornamenti 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

pageSizeType

PageSizeType

width

number

height

number

Restituisce

Promise<IHttpPostMessageResponse<void>>

resizeVisual(string, string, number, number)

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

pageName

string

visualName

string

width

number

height

number

Restituisce

Promise<IHttpPostMessageResponse<void>>

savePersistentFilters()

Salvare i filtri, i filtri dei dati e altre modifiche della visualizzazione dati del report

report.savePersistentFilters();

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

Restituisce

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Imposta i filtri a livello di report.

const filters: [
   ...
];

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

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

Parametri

filters

IFilter[]

Restituisce

Promise<IHttpPostMessageResponse<void>>

setPage(string)

Imposta la pagina attiva del report.

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

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

Parametri

pageName

string

Restituisce

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(string, string, VisualContainerDisplayMode)

Aggiornamenti 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

pageName

string

visualName

string

displayState

VisualContainerDisplayMode

Restituisce

Promise<IHttpPostMessageResponse<void>>

setZoom(number)

Imposta il livello di zoom del report.

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

Parametri

zoomLevel

number

livello di zoom da impostare

Restituisce

Promise<void>

switchLayout(LayoutType)

Aggiornamenti il layout del report

report.switchLayout(layoutType);

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

Parametri

layoutType

LayoutType

Restituisce

Promise<IHttpPostMessageResponse<void>>

switchMode(string | ViewMode)

Cambiare la modalità di visualizzazione report.

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

Parametri

viewMode

string | ViewMode

Restituisce

Promise<void>

updateFilters(FiltersOperations, IFilter[])

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

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

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

Parametri

operation

FiltersOperations

filters

IFilter[]

Restituisce

Promise<IHttpPostMessageResponse<void>>

updateSettings(ISettings)

Aggiornamenti 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

settings

ISettings

Restituisce

Promise<IHttpPostMessageResponse<void>>

Dettagli dei metodi ereditati

exitFullscreen()

Richiede al browser di uscire dalla modalità schermo intero.

function exitFullscreen()

Ereditato da Embed.exitFullscreen

fullscreen()

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

function fullscreen()

Ereditato da Embed.fullscreen

getCorrelationId()

Ottiene 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

Promise<string>

Ereditato da Embed.getCorrelationId

off<T>(string, IEventHandler<T>)

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

eventName

string

handler

IEventHandler<T>

Ereditato da Embed.off

on<T>(string, IEventHandler<T>)

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

eventName

string

handler

IEventHandler<T>

Ereditato da Embed.on

reload()

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 in stato caricato.

report.reload();

function reload(): Promise<void>

Restituisce

Promise<void>

Ereditato da Embed.reload

removeComponentTabIndex(number)

Rimuove l'attributo tabindex dell'elemento

function removeComponentTabIndex(_tabIndex?: number)

Parametri

_tabIndex

number

Ereditato da Embed.removeComponentTabIndex

save()

Salva report.

function save(): Promise<void>

Restituisce

Promise<void>

Ereditato da Embed.save

saveAs(ISaveAsParameters)

SaveAs Report.

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

Parametri

saveAsParameters

ISaveAsParameters

Restituisce

Promise<void>

Ereditato da Embed.saveAs

setAccessToken(string)

Impostare accessToken.

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

Parametri

accessToken

string

Restituisce

Promise<void>

Ereditato da Embed.setAccessToken

setComponentTabIndex(number)

Imposta l'attributo tabindex dell'elemento

function setComponentTabIndex(tabIndex?: number)

Parametri

tabIndex

number

Ereditato da Embed.setComponentTabIndex

setComponentTitle(string)

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

function setComponentTitle(title: string)

Parametri

title

string

Ereditato da Embed.setComponentTitle