Report class

bookmarksManager: BookmarksManager

Wartość właściwości

Dodaj polecenie rozszerzenia menu kontekstowego.

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

Zwraca

Dodaj polecenie rozszerzenia menu opcje.

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

Zwraca

Dodawanie pustej strony do raportu

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

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

Parametry

Zwraca

Stosowanie motywu do raportu

report.applyTheme(theme);

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

Parametry

Zwraca

Zwraca wartość, jeśli istnieją filtry, fragmentatory lub inne zmiany widoku danych zastosowane w raporcie. Jeśli filtry trwałe są wyłączone, zwraca wartość false.

report.arePersistentFiltersApplied();

function arePersistentFiltersApplied(): Promise<boolean>

Zwraca

Czyści zaznaczone wizualizacje niezmapowane, jeśli flaga zostanie przekazana, wszystkie wybrane wizualizacje zostaną wyczyszczone.

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

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

Parametry

Zwraca

Zamyka wszystkie otwarte menu kontekstowe i etykietki narzędzi.

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

function closeAllOverlays(): Promise<void>

Zwraca

Obsługa zmian konfiguracji.

function configChanged(isBootstrap: boolean)

Parametry

Usuwanie strony z raportu

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

Zwraca

Pobiera aktywną stronę raportu.

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

function getActivePage(): Promise<Page>

Zwraca

Pobiera filtry, które są stosowane na poziomie raportu.

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

function getFilters(): Promise<IFilter[]>

Zwraca

Pobiera identyfikator raportu z pierwszej dostępnej lokalizacji: opcje, atrybut, adres URL osadzania.

function getId(): string

Zwraca

Pobiera stronę raportu według jego nazwy.

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

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

Parametry

Zwraca

Pobiera listę stron w raporcie.

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

function getPages(): Promise<Page[]>

Zwraca

pobieranie motywu raportu

report.getTheme();

function getTheme(): Promise<IReportTheme>

Zwraca

Zwróć bieżący poziom powiększenia raportu.

function getZoom(): Promise<number>

Zwraca

sprawdza, czy raport jest zapisany.

report.isSaved()

function isSaved(): Promise<boolean>

Zwraca

Aktualizuje położenie wizualizacji na stronie.

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

Zwraca

Drukuje aktywną stronę raportu, wywołując window.print() w składniku osadzania elementu iframe.

function print(): Promise<void>

Zwraca

Odświeża źródła danych dla raportu.

report.refresh();

function refresh(): Promise<void>

Zwraca

Usuń polecenie rozszerzenia menu kontekstowego.

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

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

Parametry

Zwraca

Usuwa wszystkie filtry na poziomie raportu.

report.removeFilters();

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

Zwraca

Usuń polecenie rozszerzenia menu opcji.

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

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

Parametry

Zwraca

Zmienianie nazwy strony z raportu

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

Zwraca

Renderowanie wstępnie załadowanego raportu przy użyciu interfejsu API osadzania etapowego

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

...

// Render report
report.render()

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

Parametry

Zwraca

Resetowanie filtrów, fragmentatorów i innych widoków danych użytkownika zmienia się na domyślny stan raportu

report.resetPersistentFilters();

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

Zwraca

Resetowanie i stosowanie motywu domyślnego raportu

report.resetTheme();

function resetTheme(): Promise<void>

Zwraca

Aktualizuje rozmiar aktywnej strony w raporcie.

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

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

Parametry

Zwraca

Zmienianie rozmiaru wizualizacji na stronie.

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

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

Parametry

Zwraca

Zapisywanie filtrów, fragmentatorów i innych zmian widoku danych raportu

report.savePersistentFilters();

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

Zwraca

Ustawia filtry na poziomie raportu.

const filters: [
   ...
];

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

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

Parametry

Zwraca

Ustawia aktywną stronę raportu.

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

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

Parametry

Zwraca

Aktualizuje stan wyświetlania wizualizacji na stronie.

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

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

Parametry

Zwraca

Ustawia poziom powiększenia raportu.

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

Parametry

Zwraca

Aktualizuje układ raportu

report.switchLayout(layoutType);

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

Parametry

Zwraca

Przełącz tryb widoku raportu.

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

Parametry

Zwraca

Zaktualizuj filtry na poziomie raportu zgodnie z operacją: Dodaj, zastąp wszystkie, zastąp elementem docelowym lub usuń.

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

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

Parametry

Zwraca

Aktualizuje ustawienia widoczności okienka filtru i okienka nawigacji strony.

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

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

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

Parametry

Zwraca

Żąda, aby przeglądarka zakończyła tryb pełnoekranowy.

function exitFullscreen()

dziedziczone z Embed.exitFullscreen

Żąda przeglądarki renderowania elementu iframe składnika w trybie pełnoekranowym.

function fullscreen()

dziedziczone z Embed.fullscreen

Pobierz identyfikator correlationId dla bieżącej sesji osadzania.

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

function getCorrelationId(): Promise<string>

Zwraca

dziedziczone z Embed.getCorrelationId

Usuwa co najmniej jeden program obsługi zdarzeń z listy procedur obsługi. Jeśli określono odwołanie do istniejącej funkcji dojścia, usuń określoną procedurę obsługi. Jeśli program obsługi nie zostanie określony, usuń wszystkie programy obsługi dla określonej nazwy zdarzenia.

report.off('pageChanged')

or

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

report.off('pageChanged', logHandler);

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

Parametry

dziedziczone z Embed.off

Dodaje procedurę obsługi zdarzeń dla określonego zdarzenia.

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

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

Parametry

dziedziczone z Embed.on

Ponownie ładuje osadzanie przy użyciu istniejącej konfiguracji. Na przykład w przypadku raportów skutecznie usuwa wszystkie filtry i uaktywnia pierwszą stronę, która symuluje zresetowanie raportu z powrotem do stanu załadowanego.

report.reload();

function reload(): Promise<void>

Zwraca

dziedziczone z Embed.reload

Usuwa atrybut tabindex elementu

function removeComponentTabIndex(_tabIndex?: number)

Parametry

dziedziczone z Embed.removeComponentTabIndex

Zapisuje raport.

function save(): Promise<void>

Zwraca

dziedziczone z Embed.save

ZapiszAs raport.

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

Parametry

Zwraca

dziedziczone z Embed.saveAs

Ustaw wartość accessToken.

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

Parametry

Zwraca

dziedziczone z Embed.setAccessToken

Ustawia atrybut tabindex elementu

function setComponentTabIndex(tabIndex?: number)

Parametry

dziedziczone z Embed.setComponentTabIndex

Ustaw tytuł składnika pod kątem ułatwień dostępu. W przypadku elementów iframe ta metoda zmieni tytuł elementu iframe.

function setComponentTitle(title: string)

Parametry

dziedziczone z Embed.setComponentTitle