Report class

Reference

Balíček:: powerbi-client

Komponenta pro vložení sestavy Power BI

Extends: Embed

Vlastnosti

Metody

addContextMenuCommand(string, string, string, MenuLocation, string, string, string)	Přidejte příkaz rozšíření místní nabídky. `report.addContextMenuCommand(commandName, commandTitle, contextMenuTitle, menuLocation, visualName, visualType, groupName) .catch(error => { ... });`
addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)	Příkaz rozšíření nabídky Přidat možnosti `report.addOptionsMenuCommand(commandName, commandTitle, optionsMenuTitle, menuLocation, visualName, visualType, groupName, commandIcon) .catch(error => { ... });`
addPage(string)	Přidání prázdné stránky do sestavy `// Add a page to the report with "Sales" as the page display name report.addPage("Sales");`
applyTheme(IReportTheme)	Použití motivu v sestavě `report.applyTheme(theme);`
arePersistentFiltersApplied()	Vrátí hodnotu, pokud se v sestavě použijí filtry, průřezy nebo jiné změny zobrazení dat uživatele. Pokud jsou trvalé filtry zakázány, vrátí hodnotu false. `report.arePersistentFiltersApplied();`
clearSelectedVisuals(boolean)	Vymaže vybrané nevyskakované vizuály. Pokud se předá příznak, vymažou se všechny výběry vizuálů. `report.clearSelectedVisuals() .then(() => { ... });`
closeAllOverlays()	Zavře všechny otevřené místní nabídky a popisy. `report.closeAllOverlays() .then(() => { ... });`
configChanged(boolean)	Zpracování změn konfigurace
deletePage(string)	Odstranění stránky ze sestavy `// 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()	Získá aktivní stránku sestavy. `report.getActivePage() .then(activePage => { ... });`
getFilters()	Získá filtry, které jsou použity na úrovni sestavy. `// Get filters applied at report level report.getFilters() .then(filters => { ... });`
getId()	Získá ID sestavy z prvního dostupného umístění: možnosti, atribut, adresa URL pro vložení.
getPageByName(string)	Získá stránku sestavy podle názvu. `report.getPageByName(pageName) .then(page => { ... });`
getPages()	Získá seznam stránek v sestavě. `report.getPages() .then(pages => { ... });`
getTheme()	získání motivu sestavy `report.getTheme();`
getZoom()	Vrátí aktuální úroveň přiblížení sestavy.
isSaved()	zkontroluje, jestli je sestava uložená. `report.isSaved()`
moveVisual(string, string, number, number, number)	Aktualizace umístění vizuálu na stránce. `report.moveVisual(pageName, visualName, x, y, z) .catch(error => { ... });`
print()	Vytiskne aktivní stránku sestavy vyvoláním `window.print()` v komponentě embed iframe.
refresh()	Aktualizuje zdroje dat pro sestavu. `report.refresh();`
removeContextMenuCommand(string, string)	Odeberte příkaz rozšíření místní nabídky. `report.removeContextMenuCommand(commandName, contextMenuTitle) .catch(error => { ... });`
removeFilters()	Odebere všechny filtry na úrovni sestavy. `report.removeFilters();`
removeOptionsMenuCommand(string, string)	Příkaz rozšíření nabídky Odebrat možnosti `report.removeOptionsMenuCommand(commandName, optionsMenuTitle) .then({ ... });`
renamePage(string, string)	Přejmenování stránky ze sestavy `// 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)	Vykreslení předinstalované sestavy pomocí rozhraní API pro fázované vkládání `// Load report var report = powerbi.load(element, config); ... // Render report report.render()`
resetPersistentFilters()	Resetování změn uživatelských filtrů, průřezů a dalších zobrazení dat do výchozího stavu sestavy `report.resetPersistentFilters();`
resetTheme()	Resetování a použití výchozího motivu sestavy `report.resetTheme();`
resizeActivePage(PageSizeType, number, number)	Aktualizace velikost aktivní stránky v sestavě. `report.resizeActivePage(pageSizeType, width, height) .catch(error => { ... });`
resizeVisual(string, string, number, number)	Změna velikosti vizuálu na stránce `report.resizeVisual(pageName, visualName, width, height) .catch(error => { ... });`
savePersistentFilters()	Uložení uživatelských filtrů, průřezů a dalších změn zobrazení dat sestavy `report.savePersistentFilters();`
setFilters(IFilter[])	Nastaví filtry na úrovni sestavy. `const filters: [ ... ]; report.setFilters(filters) .catch(errors => { ... });`
setPage(string)	Nastaví aktivní stránku sestavy. `report.setPage("page2") .catch(error => { ... });`
setVisualDisplayState(string, string, VisualContainerDisplayMode)	Aktualizace stav zobrazení vizuálu na stránce. `report.setVisualDisplayState(pageName, visualName, displayState) .catch(error => { ... });`
setZoom(number)	Nastaví úroveň přiblížení sestavy.
switchLayout(LayoutType)	Aktualizace rozložení sestavy `report.switchLayout(layoutType);`
switchMode(string \| ViewMode)	Přepněte režim zobrazení sestavy.
updateFilters(FiltersOperations, IFilter[])	Aktualizujte filtry na úrovni sestavy podle operace: Přidat, nahradit vše, nahradit cílem nebo odebrat. `report.updateFilters(FiltersOperations.Add, filters) .catch(errors => { ... });`
updateSettings(ISettings)	Aktualizace nastavení viditelnosti pro podokno filtru a navigační podokno stránky. `const newSettings = { panes: { filters: { visible: false } } }; report.updateSettings(newSettings) .catch(error => { ... });`

Zděděné metody

exitFullscreen()	Požádá prohlížeč o ukončení režimu zobrazení na celé obrazovce.
fullscreen()	Požádá prohlížeč o vykreslení prvku iframe komponenty v režimu zobrazení na celou obrazovku.
getCorrelationId()	Získejte ID korelace pro aktuální relaci vložení. `// Get the correlationId for the current embed session report.getCorrelationId() .then(correlationId => { ... });`
off<T>(string, IEventHandler<T>)	Odebere jednu nebo více obslužných rutin událostí ze seznamu obslužných rutin. Pokud je zadán odkaz na existující funkci popisovače, odeberte konkrétní obslužnou rutinu. Pokud obslužná rutina není zadána, odeberte všechny obslužné rutiny pro zadaný název události. `report.off('pageChanged') or const logHandler = function (event) { console.log(event); }; report.off('pageChanged', logHandler);`
on<T>(string, IEventHandler<T>)	Přidá obslužnou rutinu události pro konkrétní událost. `report.on('pageChanged', (event) => { console.log('PageChanged: ', event.page.name); });`
reload()	Znovu načte vložení pomocí existující konfigurace. Například u sestav tím efektivně vymažete všechny filtry a aktivujete první stránku, která simuluje resetování sestavy zpět do stavu načtení. `report.reload();`
removeComponentTabIndex(number)	Odebere atribut tabindex elementu.
save()	Uloží sestavu.
saveAs(ISaveAsParameters)	SaveAs Report.
setAccessToken(string)	Nastavte accessToken.
setComponentTabIndex(number)	Nastaví atribut tabindex elementu.
setComponentTitle(string)	Nastavte název komponenty pro usnadnění přístupu. V případě rámců iframe tato metoda změní název prvku iframe.

Podrobnosti vlastnosti

bookmarksManager

bookmarksManager: BookmarksManager

Hodnota vlastnosti

BookmarksManager

Podrobnosti metody

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

Přidejte příkaz rozšíření místní nabídky.

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

Parametry

commandName: string

commandTitle: string

contextMenuTitle: string

menuLocation: MenuLocation

visualName: string

visualType: string

groupName: string

Návraty

Promise<IHttpPostMessageResponse<void>>

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

Příkaz rozšíření nabídky Přidat možnosti

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

Parametry

commandName: string

commandTitle: string

optionsMenuTitle: string

menuLocation: MenuLocation

visualName: string

visualType: string

groupName: string

commandIcon: string

Návraty

Promise<IHttpPostMessageResponse<void>>

addPage(string)

Přidání prázdné stránky do sestavy

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

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

Parametry

displayName: string

Návraty

Promise<Page>

applyTheme(IReportTheme)

Použití motivu v sestavě

report.applyTheme(theme);

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

Parametry

theme: IReportTheme

Návraty

Promise<void>

arePersistentFiltersApplied()

Vrátí hodnotu, pokud se v sestavě použijí filtry, průřezy nebo jiné změny zobrazení dat uživatele. Pokud jsou trvalé filtry zakázány, vrátí hodnotu false.

report.arePersistentFiltersApplied();

function arePersistentFiltersApplied(): Promise<boolean>

Návraty

Promise<boolean>

clearSelectedVisuals(boolean)

Vymaže vybrané nevyskakované vizuály. Pokud se předá příznak, vymažou se všechny výběry vizuálů.

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

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

Parametry

clearPopOutState: boolean

Pokud je některý z vizuálů ve stavu vysunutý (fokus, zobrazit jako tabulku, spotlight...), výběr vizuálů se nevymaže.

Návraty

Promise<void>

closeAllOverlays()

Zavře všechny otevřené místní nabídky a popisy.

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

function closeAllOverlays(): Promise<void>

Návraty

Promise<void>

configChanged(boolean)

Zpracování změn konfigurace

function configChanged(isBootstrap: boolean)

Parametry

isBootstrap: boolean

deletePage(string)

Odstranění stránky ze sestavy

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

Parametry

pageName: string

Návraty

Promise<void>

getActivePage()

Získá aktivní stránku sestavy.

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

function getActivePage(): Promise<Page>

Návraty

Promise<Page>

getFilters()

Získá filtry, které jsou použity na úrovni sestavy.

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

function getFilters(): Promise<IFilter[]>

Návraty

Promise<IFilter[]>

getId()

Získá ID sestavy z prvního dostupného umístění: možnosti, atribut, adresa URL pro vložení.

function getId(): string

Návraty

string

getPageByName(string)

Získá stránku sestavy podle názvu.

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

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

Parametry

pageName: string

Návraty

Promise<Page>

getPages()

Získá seznam stránek v sestavě.

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

function getPages(): Promise<Page[]>

Návraty

Promise<Page[]>

getTheme()

získání motivu sestavy

report.getTheme();

function getTheme(): Promise<IReportTheme>

Návraty

Promise<IReportTheme>

getZoom()

Vrátí aktuální úroveň přiblížení sestavy.

function getZoom(): Promise<number>

Návraty

Promise<number>

isSaved()

zkontroluje, jestli je sestava uložená.

report.isSaved()

function isSaved(): Promise<boolean>

Návraty

Promise<boolean>

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

Aktualizace umístění vizuálu na stránce.

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

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

Parametry

pageName: string

visualName: string

x: number

y: number

z: number

Návraty

Promise<IHttpPostMessageResponse<void>>

print()

Vytiskne aktivní stránku sestavy vyvoláním window.print() v komponentě embed iframe.

function print(): Promise<void>

Návraty

Promise<void>

refresh()

Aktualizuje zdroje dat pro sestavu.

report.refresh();

function refresh(): Promise<void>

Návraty

Promise<void>

removeContextMenuCommand(string, string)

Odeberte příkaz rozšíření místní nabídky.

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

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

Parametry

commandName: string

contextMenuTitle: string

Návraty

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Odebere všechny filtry na úrovni sestavy.

report.removeFilters();

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

Návraty

Promise<IHttpPostMessageResponse<void>>

removeOptionsMenuCommand(string, string)

Příkaz rozšíření nabídky Odebrat možnosti

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

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

Parametry

commandName: string

optionsMenuTitle: string

Návraty

Promise<IHttpPostMessageResponse<void>>

renamePage(string, string)

Přejmenování stránky ze sestavy

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

Parametry

pageName: string

displayName: string

Návraty

Promise<void>

render(IReportEmbedConfiguration | IReportLoadConfiguration)

Vykreslení předinstalované sestavy pomocí rozhraní API pro fázované vkládání

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

...

// Render report
report.render()

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

Parametry

config: IReportEmbedConfiguration | IReportLoadConfiguration

Návraty

Promise<void>

resetPersistentFilters()

Resetování změn uživatelských filtrů, průřezů a dalších zobrazení dat do výchozího stavu sestavy

report.resetPersistentFilters();

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

Návraty

Promise<IHttpPostMessageResponse<void>>

resetTheme()

Resetování a použití výchozího motivu sestavy

report.resetTheme();

function resetTheme(): Promise<void>

Návraty

Promise<void>

resizeActivePage(PageSizeType, number, number)

Aktualizace velikost aktivní stránky v sestavě.

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

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

Parametry

pageSizeType: PageSizeType

width: number

height: number

Návraty

Promise<IHttpPostMessageResponse<void>>

resizeVisual(string, string, number, number)

Změna velikosti vizuálu na stránce

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

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

Parametry

pageName: string

visualName: string

width: number

height: number

Návraty

Promise<IHttpPostMessageResponse<void>>

savePersistentFilters()

Uložení uživatelských filtrů, průřezů a dalších změn zobrazení dat sestavy

report.savePersistentFilters();

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

Návraty

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Nastaví filtry na úrovni sestavy.

const filters: [
   ...
];

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

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

Parametry

filters: IFilter[]

Návraty

Promise<IHttpPostMessageResponse<void>>

setPage(string)

Nastaví aktivní stránku sestavy.

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

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

Parametry

pageName: string

Návraty

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(string, string, VisualContainerDisplayMode)

Aktualizace stav zobrazení vizuálu na stránce.

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

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

Parametry

pageName: string

visualName: string

displayState: VisualContainerDisplayMode

Návraty

Promise<IHttpPostMessageResponse<void>>

setZoom(number)

Nastaví úroveň přiblížení sestavy.

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

Parametry

zoomLevel: number

úroveň přiblížení, která se má nastavit

Návraty

Promise<void>

switchLayout(LayoutType)

Aktualizace rozložení sestavy

report.switchLayout(layoutType);

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

Parametry

layoutType: LayoutType

Návraty

Promise<IHttpPostMessageResponse<void>>

switchMode(string | ViewMode)

Přepněte režim zobrazení sestavy.

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

Parametry

viewMode: string | ViewMode

Návraty

Promise<void>

updateFilters(FiltersOperations, IFilter[])

Aktualizujte filtry na úrovni sestavy podle operace: Přidat, nahradit vše, nahradit cílem nebo odebrat.

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

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

Parametry

operation: FiltersOperations

filters: IFilter[]

Návraty

Promise<IHttpPostMessageResponse<void>>

updateSettings(ISettings)

Aktualizace nastavení viditelnosti pro podokno filtru a navigační podokno stránky.

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

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

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

Parametry

settings: ISettings

Návraty

Promise<IHttpPostMessageResponse<void>>

Podrobnosti zděděných metod

exitFullscreen()

Požádá prohlížeč o ukončení režimu zobrazení na celé obrazovce.

function exitFullscreen()

Zděděno z Embed.exitFullscreen

fullscreen()

Požádá prohlížeč o vykreslení prvku iframe komponenty v režimu zobrazení na celou obrazovku.

function fullscreen()

Zděděno z Embed.fullscreen

getCorrelationId()

Získejte ID korelace pro aktuální relaci vložení.

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

function getCorrelationId(): Promise<string>

Návraty

Promise<string>

Zděděno z Embed.getCorrelationId

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

Odebere jednu nebo více obslužných rutin událostí ze seznamu obslužných rutin. Pokud je zadán odkaz na existující funkci popisovače, odeberte konkrétní obslužnou rutinu. Pokud obslužná rutina není zadána, odeberte všechny obslužné rutiny pro zadaný název události.

report.off('pageChanged')

or

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

report.off('pageChanged', logHandler);

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

Parametry

eventName: string

handler: IEventHandler<T>

Zděděno z Embed.off

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

Přidá obslužnou rutinu události pro konkrétní událost.

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

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

Parametry

eventName: string

handler: IEventHandler<T>

Zděděno z Embed.on

reload()

Znovu načte vložení pomocí existující konfigurace. Například u sestav tím efektivně vymažete všechny filtry a aktivujete první stránku, která simuluje resetování sestavy zpět do stavu načtení.

report.reload();

function reload(): Promise<void>

Návraty

Promise<void>

Zděděno z Embed.reload

removeComponentTabIndex(number)

Odebere atribut tabindex elementu.

function removeComponentTabIndex(_tabIndex?: number)

Parametry

_tabIndex: number

Zděděno z Embed.removeComponentTabIndex

save()

Uloží sestavu.

function save(): Promise<void>

Návraty

Promise<void>

Zděděno z Embed.save

saveAs(ISaveAsParameters)

SaveAs Report.

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

Parametry

saveAsParameters: ISaveAsParameters

Návraty

Promise<void>

Zděděno z Embed.saveAs

setAccessToken(string)

Nastavte accessToken.

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

Parametry

accessToken: string

Návraty

Promise<void>

Zděděno z Embed.setAccessToken

setComponentTabIndex(number)

Nastaví atribut tabindex elementu.

function setComponentTabIndex(tabIndex?: number)

Parametry

tabIndex: number

Zděděno z Embed.setComponentTabIndex

setComponentTitle(string)

Nastavte název komponenty pro usnadnění přístupu. V případě rámců iframe tato metoda změní název prvku iframe.

function setComponentTitle(title: string)

Parametry

title: string

Zděděno z Embed.setComponentTitle

Sdílet prostřednictvím

Report class

Vlastnosti

Metody

Zděděné metody

Podrobnosti vlastnosti

bookmarksManager

Hodnota vlastnosti

Podrobnosti metody

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

Parametry

Návraty

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

Parametry

Návraty

addPage(string)

Parametry

Návraty

applyTheme(IReportTheme)

Parametry

Návraty

arePersistentFiltersApplied()

Návraty

clearSelectedVisuals(boolean)

Parametry

Návraty

closeAllOverlays()

Návraty

configChanged(boolean)

Parametry

deletePage(string)

Parametry

Návraty

getActivePage()

Návraty

getFilters()

Návraty

getId()

Návraty

getPageByName(string)

Parametry

Návraty

getPages()

Návraty

getTheme()

Návraty

getZoom()

Návraty

isSaved()

Návraty

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

Parametry

Návraty

print()

Návraty

refresh()

Návraty

removeContextMenuCommand(string, string)

Parametry

Návraty

removeFilters()

Návraty

removeOptionsMenuCommand(string, string)

Parametry

Návraty

renamePage(string, string)

Parametry

Návraty

render(IReportEmbedConfiguration | IReportLoadConfiguration)

Parametry

Návraty

resetPersistentFilters()

Návraty

resetTheme()

Návraty

resizeActivePage(PageSizeType, number, number)

Parametry

Návraty

resizeVisual(string, string, number, number)

Parametry