Report class

bookmarksManager: BookmarksManager

Hodnota vlastnosti

Add context menu extension command.

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

Návraty

Přidání příkazu rozšíření nabídky 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

Návraty

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

Návraty

Použití motivu v sestavě

report.applyTheme(theme);

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

Parametry

Návraty

Vrátí, 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

Vymaže vybrané vizuály, které se nevypnou, pokud je příznak předán, výběry všech vizuálů se vymažou.

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

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

Parametry

Návraty

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

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

function closeAllOverlays(): Promise<void>

Návraty

Zpracování změn konfigurace

function configChanged(isBootstrap: boolean)

Parametry

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

Návraty

Získá aktivní stránku sestavy.

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

function getActivePage(): Promise<Page>

Návraty

Získá filtry použité na úrovni sestavy.

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

function getFilters(): Promise<IFilter[]>

Návraty

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

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

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

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

Parametry

Návraty

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

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

function getPages(): Promise<Page[]>

Návraty

získání motivu sestavy

report.getTheme();

function getTheme(): Promise<IReportTheme>

Návraty

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

function getZoom(): Promise<number>

Návraty

zkontroluje, jestli je sestava uložená.

report.isSaved()

function isSaved(): Promise<boolean>

Návraty

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

Návraty

Vytiskne aktivní stránku sestavy vyvoláním window.print() na komponentě iframe pro vložení.

function print(): Promise<void>

Návraty

Aktualizuje zdroje dat pro sestavu.

report.refresh();

function refresh(): Promise<void>

Návraty

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

Návraty

Odebere všechny filtry na úrovni sestavy.

report.removeFilters();

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

Návraty

Příkaz pro odebrání rozšíření nabídky Možnosti

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

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

Parametry

Návraty

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

Návraty

Vykreslení předem načtené sestavy pomocí fázovaného rozhraní API pro vložení

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

...

// Render report
report.render()

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

Parametry

Návraty

Resetování filtrů, průřezů a dalších zobrazení dat uživatele ve výchozím stavu sestavy

report.resetPersistentFilters();

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

Návraty

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

report.resetTheme();

function resetTheme(): Promise<void>

Návraty

Aktualizuje 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

Návraty

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

Návraty

Uložení filtrů, průřezů a dalších změn zobrazení dat v sestavě uživatele

report.savePersistentFilters();

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

Návraty

Nastaví filtry na úrovni sestavy.

const filters: [
   ...
];

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

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

Parametry

Návraty

Nastaví aktivní stránku sestavy.

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

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

Parametry

Návraty

Aktualizuje 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

Návraty

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

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

Parametry

Návraty

Aktualizuje rozložení sestavy.

report.switchLayout(layoutType);

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

Parametry

Návraty

Přepnout režim zobrazení sestavy

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

Parametry

Návraty

Aktualizujte filtry na úrovni sestavy podle operace: Přidejte, nahraďte vše, nahraďte cílem nebo odebráním.

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

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

Parametry

Návraty

Aktualizuje 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

Návraty

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

function exitFullscreen()

zděděný z obrazovky Embed.exitFullscreen

Požádá prohlížeč o vykreslení prvku iframe komponenty v režimu celé obrazovky.

function fullscreen()

zděděno z obrazovky Embed.fullscreen

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

zděděno z Embed.getCorrelationId

Odebere jeden 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 není zadaná obslužná rutina, 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

zděděno z Embed.off

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

zděděno z Embed.on

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

report.reload();

function reload(): Promise<void>

Návraty

zděděno ze souboru Embed.reload

Odebere atribut tabindex elementu.

function removeComponentTabIndex(_tabIndex?: number)

Parametry

zděděno z Embed.removeComponentTabIndex

Uloží sestavu.

function save(): Promise<void>

Návraty

zděděno z Embed.save

Sestava SaveAs

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

Parametry

Návraty

zděděno z Embed.saveAs

Nastavte accessToken.

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

Parametry

Návraty

zděděno z Embed.setAccessToken

Nastaví atribut tabindex elementu.

function setComponentTabIndex(tabIndex?: number)

Parametry

zděděno z Embed.setComponentTabIndex

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

function setComponentTitle(title: string)

Parametry

zděděno z Embed.setComponentTitle