Visual class

bookmarksManager: BookmarksManager

Wartość właściwości

dziedziczone zReport.bookmarksManager

Pobiera filtry stosowane do poziomu filtru. Domyślny poziom filtru to poziom wizualizacji.

visual.getFilters(filtersLevel)
  .then(filters => {
    ...
  });

function getFilters(filtersLevel?: FiltersLevel): Promise<IFilter[]>

Parametry

Zwraca

Pobiera listę stron w raporcie — nieobsługiwana w wizualizacji

function getPages(): Promise<Page[]>

Zwraca

Pobiera osadzony obiekt deskryptora wizualizacji, który zawiera nazwę wizualizacji, typ itp.

visual.getVisualDescriptor()
  .then(visualDetails => { ... });

function getVisualDescriptor(): Promise<VisualDescriptor>

Zwraca

Usuwa wszystkie filtry z bieżącego poziomu filtru. Domyślny poziom filtru to poziom wizualizacji.

visual.removeFilters(filtersLevel);

function removeFilters(filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>

Parametry

Zwraca

Ustawia filtry na poziomie filtru. Domyślny poziom filtru to poziom wizualizacji.

const filters: [
   ...
];

visual.setFilters(filters, filtersLevel)
 .catch(errors => {
   ...
 });

function setFilters(filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>

Parametry

Zwraca

Ustawia aktywną stronę raportu — nieobsługiwana w wizualizacji

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

Parametry

Zwraca

Aktualizacje filtrów na poziomie filtru. Domyślny poziom filtru to poziom wizualizacji.

const filters: [
   ...
];

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

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

Parametry

Zwraca

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

dziedziczone zReport.addContextMenuCommand

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

dziedziczone zReport.addOptionsMenuCommand

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

dziedziczone zReport.addPage

Stosowanie motywu do raportu

report.applyTheme(theme);

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

Parametry

Zwraca

dziedziczone zReport.applyTheme

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

dziedziczone zReport.arePersistentFiltersApplied

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

dziedziczone zReport.clearSelectedVisuals

Zamyka wszystkie otwarte menu kontekstowe i etykietki narzędzi.

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

function closeAllOverlays(): Promise<void>

Zwraca

dziedziczone zReport.closeAllOverlays

Obsługa zmian konfiguracji.

function configChanged(isBootstrap: boolean)

Parametry

dziedziczone zReport.configChanged

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

dziedziczone zReport.deletePage

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

function exitFullscreen()

dziedziczone zReport.exitFullscreen

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

function fullscreen()

dziedziczone zReport.fullscreen

Pobiera aktywną stronę raportu.

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

function getActivePage(): Promise<Page>

Zwraca

dziedziczone zReport.getActivePage

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 zReport.getCorrelationId

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

function getId(): string

Zwraca

dziedziczone zReport.getId

Pobiera stronę raportu według jego nazwy.

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

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

Parametry

Zwraca

dziedziczone zReport.getPageByName

pobieranie motywu raportu

report.getTheme();

function getTheme(): Promise<IReportTheme>

Zwraca

dziedziczone zReport.getTheme

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

function getZoom(): Promise<number>

Zwraca

dziedziczone zReport.getZoom

sprawdza, czy raport jest zapisany.

report.isSaved()

function isSaved(): Promise<boolean>

Zwraca

dziedziczone zReport.isSaved

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

dziedziczone zReport.moveVisual

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 zReport.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 zReport.on

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

function print(): Promise<void>

Zwraca

dziedziczone z Report.print

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

report.refresh();

function refresh(): Promise<void>

Zwraca

dziedziczone zReport.refresh

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 zReport.reload

Usuwa atrybut tabindex elementu

function removeComponentTabIndex(_tabIndex?: number)

Parametry

dziedziczone zReport.removeComponentTabIndex

Usuń polecenie rozszerzenia menu kontekstowego.

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

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

Parametry

Zwraca

dziedziczone zReport.removeContextMenuCommand

Usuń polecenie rozszerzenia menu opcji.

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

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

Parametry

Zwraca

dziedziczone zReport.removeOptionsMenuCommand

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

dziedziczone zReport.renamePage

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

dziedziczone zReport.resetPersistentFilters

Resetowanie i stosowanie motywu domyślnego raportu

report.resetTheme();

function resetTheme(): Promise<void>

Zwraca

dziedziczone zReport.resetTheme

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

dziedziczone zReport.resizeActivePage

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

dziedziczone zReport.resizeVisual

Zapisuje raport.

function save(): Promise<void>

Zwraca

dziedziczone zReport.save

ZapiszAs raport.

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

Parametry

Zwraca

dziedziczone zReport.saveAs

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

report.savePersistentFilters();

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

Zwraca

dziedziczone zReport.savePersistentFilters

Ustaw wartość accessToken.

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

Parametry

Zwraca

dziedziczone zReport.setAccessToken

Ustawia atrybut tabindex elementu

function setComponentTabIndex(tabIndex?: number)

Parametry

dziedziczone zReport.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 zReport.setComponentTitle

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

dziedziczone zReport.setVisualDisplayState

Ustawia poziom powiększenia raportu.

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

Parametry

Zwraca

dziedziczone zReport.setZoom

Aktualizuje układ raportu

report.switchLayout(layoutType);

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

Parametry

Zwraca

dziedziczone zReport.switchLayout

Przełącz tryb widoku raportu.

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

Parametry

Zwraca

dziedziczone zReport.switchMode

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

dziedziczone zReport.updateSettings