Visual class

Referenz

Paket:: powerbi-client

Die Visual Embed-Komponente von Power BI

Extends: Report

Geerbte Eigenschaften

Methoden

getFilters(FiltersLevel)	Ruft Filter ab, die auf die Filterebene angewendet werden. Die Standardfilterebene ist visuelle Ebene. `visual.getFilters(filtersLevel) .then(filters => { ... });`
getPages()	Ruft die Liste der Seiten innerhalb des Berichts ab – nicht unterstützt in visuellen Elementen
getVisualDescriptor()	Ruft das eingebettete visuelle Deskriptorobjekt ab, das den visuellen Namen, typ usw. enthält. `visual.getVisualDescriptor() .then(visualDetails => { ... });`
removeFilters(FiltersLevel)	Entfernt alle Filter aus der aktuellen Filterebene. Die Standardfilterebene ist visuelle Ebene. `visual.removeFilters(filtersLevel);`
setFilters(IFilter[], FiltersLevel)	Legt Filter auf Filterebene fest. Die Standardfilterebene ist visuelle Ebene. `const filters: [ ... ]; visual.setFilters(filters, filtersLevel) .catch(errors => { ... });`
setPage(string)	Legt die aktive Seite des Berichts fest – wird in visuellen Elementen nicht unterstützt.
updateFilters(FiltersOperations, IFilter[], FiltersLevel)	Aktualisiert Filter auf Filterebene. Die Standardfilterebene ist visuelle Ebene. `const filters: [ ... ]; visual.updateFilters(FiltersOperations.Add, filters, filtersLevel) .catch(errors => { ... });`

Geerbte Methoden

addContextMenuCommand(string, string, string, MenuLocation, string, string, string)	Hinzufügen des Kontextmenüerweiterungsbefehls. `report.addContextMenuCommand(commandName, commandTitle, contextMenuTitle, menuLocation, visualName, visualType, groupName) .catch(error => { ... });`
addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)	Menüerweiterungsbefehl 'Optionen hinzufügen'. `report.addOptionsMenuCommand(commandName, commandTitle, optionsMenuTitle, menuLocation, visualName, visualType, groupName, commandIcon) .catch(error => { ... });`
addPage(string)	Hinzufügen einer leeren Seite zum Bericht `// Add a page to the report with "Sales" as the page display name report.addPage("Sales");`
applyTheme(IReportTheme)	Anwenden eines Designs auf den Bericht `report.applyTheme(theme);`
arePersistentFiltersApplied()	Gibt zurück, wenn auf den Bericht Filter, Datenschnitte oder andere Datenansichtsänderungen angewendet werden. Wenn persistente Filter deaktiviert sind, wird "false" zurückgegeben. `report.arePersistentFiltersApplied();`
clearSelectedVisuals(boolean)	Löscht ausgewählte visuelle Elemente, die nicht angezeigt werden, wenn die Kennzeichnung übergeben wird, werden alle visuellen Auswahlen gelöscht. `report.clearSelectedVisuals() .then(() => { ... });`
closeAllOverlays()	Schließt alle geöffneten Kontextmenüs und QuickInfos. `report.closeAllOverlays() .then(() => { ... });`
configChanged(boolean)	Behandeln von Konfigurationsänderungen.
deletePage(string)	Löschen einer Seite aus einem Bericht `// 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");`
exitFullscreen()	Fordert den Browser auf, den Vollbildmodus zu beenden.
fullscreen()	Fordert den Browser auf, den iFrame der Komponente im Vollbildmodus zu rendern.
getActivePage()	Ruft die aktive Berichtsseite ab. `report.getActivePage() .then(activePage => { ... });`
getCorrelationId()	Rufen Sie die Korrelations-ID für die aktuelle Einbettungssitzung ab. `// Get the correlationId for the current embed session report.getCorrelationId() .then(correlationId => { ... });`
getId()	Ruft die Berichts-ID vom ersten verfügbaren Speicherort ab: Optionen, Attribut, Einbettungs-URL.
getPageByName(string)	Ruft eine Berichtsseite anhand des Namens ab. `report.getPageByName(pageName) .then(page => { ... });`
getTheme()	Abrufen des Designs des Berichts `report.getTheme();`
getZoom()	Gibt den aktuellen Zoomfaktor des Berichts zurück.
isSaved()	überprüft, ob der Bericht gespeichert wird. `report.isSaved()`
moveVisual(string, string, number, number, number)	Aktualisiert die Position eines visuellen Elements auf einer Seite. `report.moveVisual(pageName, visualName, x, y, z) .catch(error => { ... });`
off<T>(string, IEventHandler<T>)	Entfernt einen oder mehrere Ereignishandler aus der Liste der Handler. Wenn ein Verweis auf die vorhandene Handle-Funktion angegeben ist, entfernen Sie den spezifischen Handler. Wenn der Handler nicht angegeben ist, entfernen Sie alle Handler für den angegebenen Ereignisnamen. `report.off('pageChanged') or const logHandler = function (event) { console.log(event); }; report.off('pageChanged', logHandler);`
on<T>(string, IEventHandler<T>)	Fügt einen Ereignishandler für ein bestimmtes Ereignis hinzu. `report.on('pageChanged', (event) => { console.log('PageChanged: ', event.page.name); });`
print()	Druckt die aktive Seite des Berichts, indem sie `window.print()` in die Komponente "iframe einbetten" aufruft.
refresh()	Aktualisiert Datenquellen für den Bericht. `report.refresh();`
reload()	Lädt das Einbetten mithilfe einer vorhandenen Konfiguration neu. Für Berichte werden dadurch beispielsweise alle Filter effektiv gelöscht und die erste Seite aktiv, die das Zurücksetzen eines Berichts auf den geladenen Zustand simuliert. `report.reload();`
removeComponentTabIndex(number)	Entfernt das Tabindex-Attribut des Elements.
removeContextMenuCommand(string, string)	Befehl "Kontextmenüerweiterung entfernen". `report.removeContextMenuCommand(commandName, contextMenuTitle) .catch(error => { ... });`
removeOptionsMenuCommand(string, string)	Menüerweiterungsbefehl "Optionen entfernen". `report.removeOptionsMenuCommand(commandName, optionsMenuTitle) .then({ ... });`
renamePage(string, string)	Umbenennen einer Seite aus einem Bericht `// 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");`
resetPersistentFilters()	Zurücksetzen der Filter, Datenschnitte und anderer Datenansichtsänderungen des Benutzers auf den Standardzustand des Berichts `report.resetPersistentFilters();`
resetTheme()	Zurücksetzen und Anwenden des Standarddesigns des Berichts `report.resetTheme();`
resizeActivePage(PageSizeType, number, number)	Aktualisiert die Größe der aktiven Seite im Bericht. `report.resizeActivePage(pageSizeType, width, height) .catch(error => { ... });`
resizeVisual(string, string, number, number)	Ändern Sie die Größe eines visuellen Elements auf einer Seite. `report.resizeVisual(pageName, visualName, width, height) .catch(error => { ... });`
save()	Speichert den Bericht.
saveAs(ISaveAsParameters)	SaveAs-Bericht.
savePersistentFilters()	Speichern der Filter, Datenschnitte und anderer Datenansichtsänderungen des Berichts `report.savePersistentFilters();`
setAccessToken(string)	Legen Sie accessToken fest.
setComponentTabIndex(number)	Tabindex-Attribut des Sets-Elements
setComponentTitle(string)	Legen Sie den Komponententitel für Barrierefreiheit fest. Bei iframes ändert diese Methode den iframe-Titel.
setVisualDisplayState(string, string, VisualContainerDisplayMode)	Aktualisiert den Anzeigezustand eines visuellen Elements auf einer Seite. `report.setVisualDisplayState(pageName, visualName, displayState) .catch(error => { ... });`
setZoom(number)	Legt den Zoomfaktor des Berichts fest.
switchLayout(LayoutType)	Aktualisiert das Berichtslayout. `report.switchLayout(layoutType);`
switchMode(string \| ViewMode)	Wechseln des Berichtsansichtsmodus.
updateSettings(ISettings)	Aktualisiert die Sichtbarkeitseinstellungen für den Filterbereich und den Seitennavigationsbereich. `const newSettings = { panes: { filters: { visible: false } } }; report.updateSettings(newSettings) .catch(error => { ... });`

Geerbte Eigenschaftsdetails

bookmarksManager

bookmarksManager: BookmarksManager

Eigenschaftswert

BookmarksManager

VonReport.bookmarksManager geerbt

Details zur Methode

getFilters(FiltersLevel)

Ruft Filter ab, die auf die Filterebene angewendet werden. Die Standardfilterebene ist visuelle Ebene.

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

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

Parameter

filtersLevel: FiltersLevel

Gibt zurück

Promise<IFilter[]>

getPages()

Ruft die Liste der Seiten innerhalb des Berichts ab – nicht unterstützt in visuellen Elementen

function getPages(): Promise<Page[]>

Gibt zurück

Promise<Page[]>

getVisualDescriptor()

Ruft das eingebettete visuelle Deskriptorobjekt ab, das den visuellen Namen, typ usw. enthält.

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

function getVisualDescriptor(): Promise<VisualDescriptor>

Gibt zurück

Promise<VisualDescriptor>

removeFilters(FiltersLevel)

Entfernt alle Filter aus der aktuellen Filterebene. Die Standardfilterebene ist visuelle Ebene.

visual.removeFilters(filtersLevel);

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

Parameter

filtersLevel: FiltersLevel

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[], FiltersLevel)

Legt Filter auf Filterebene fest. Die Standardfilterebene ist visuelle Ebene.

const filters: [
   ...
];

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

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

Parameter

filters: IFilter[]

filtersLevel: FiltersLevel

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

setPage(string)

Legt die aktive Seite des Berichts fest – wird in visuellen Elementen nicht unterstützt.

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

Parameter

_pageName: string

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[], FiltersLevel)

Aktualisiert Filter auf Filterebene. Die Standardfilterebene ist visuelle Ebene.

const filters: [
   ...
];

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

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

Parameter

operation: FiltersOperations

filters: IFilter[]

filtersLevel: FiltersLevel

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

Details zur geerbten Methode

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

Hinzufügen des Kontextmenüerweiterungsbefehls.

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

Parameter

commandName: string

commandTitle: string

contextMenuTitle: string

menuLocation: MenuLocation

visualName: string

visualType: string

groupName: string

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

Geerbt vonReport.addContextMenuCommand-

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

Menüerweiterungsbefehl 'Optionen hinzufügen'.

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

Parameter

commandName: string

commandTitle: string

optionsMenuTitle: string

menuLocation: MenuLocation

visualName: string

visualType: string

groupName: string

commandIcon: string

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

Geerbt vonReport.addOptionsMenuCommand-

addPage(string)

Hinzufügen einer leeren Seite zum Bericht

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

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

Parameter

displayName: string

Gibt zurück

Promise<Page>

geerbt vonReport.addPage-

applyTheme(IReportTheme)

Anwenden eines Designs auf den Bericht

report.applyTheme(theme);

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

Parameter

theme: IReportTheme

Gibt zurück

Promise<void>

Geerbt vonReport.applyTheme

arePersistentFiltersApplied()

Gibt zurück, wenn auf den Bericht Filter, Datenschnitte oder andere Datenansichtsänderungen angewendet werden. Wenn persistente Filter deaktiviert sind, wird "false" zurückgegeben.

report.arePersistentFiltersApplied();

function arePersistentFiltersApplied(): Promise<boolean>

Gibt zurück

Promise<boolean>

Geerbt vonReport.arePersistentFiltersApplied

clearSelectedVisuals(boolean)

Löscht ausgewählte visuelle Elemente, die nicht angezeigt werden, wenn die Kennzeichnung übergeben wird, werden alle visuellen Auswahlen gelöscht.

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

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

Parameter

clearPopOutState: boolean

Wenn die Auswahl falsch/nicht definierter visueller Elemente nicht gelöscht wird, wenn sich ein visueller Bereich im Ausblendezustand befindet (im Fokus, als Tabelle anzeigen, Spotlight...)

Gibt zurück

Promise<void>

Geerbt vonReport.clearSelectedVisuals

closeAllOverlays()

Schließt alle geöffneten Kontextmenüs und QuickInfos.

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

function closeAllOverlays(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonReport.closeAllOverlays

configChanged(boolean)

Behandeln von Konfigurationsänderungen.

function configChanged(isBootstrap: boolean)

Parameter

isBootstrap: boolean

geerbt vonReport.configChanged

deletePage(string)

Löschen einer Seite aus einem Bericht

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

Parameter

pageName: string

Gibt zurück

Promise<void>

geerbt vonReport.deletePage-

exitFullscreen()

Fordert den Browser auf, den Vollbildmodus zu beenden.

function exitFullscreen()

Geerbt vonReport.exitFullscreen-

fullscreen()

Fordert den Browser auf, den iFrame der Komponente im Vollbildmodus zu rendern.

function fullscreen()

geerbt vonReport.fullscreen-

getActivePage()

Ruft die aktive Berichtsseite ab.

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

function getActivePage(): Promise<Page>

Gibt zurück

Promise<Page>

VonReport.getActivePage geerbt

getCorrelationId()

Rufen Sie die Korrelations-ID für die aktuelle Einbettungssitzung ab.

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

function getCorrelationId(): Promise<string>

Gibt zurück

Promise<string>

Geerbt vonReport.getCorrelationId-

getId()

Ruft die Berichts-ID vom ersten verfügbaren Speicherort ab: Optionen, Attribut, Einbettungs-URL.

function getId(): string

Gibt zurück

string

Geerbt vonReport.getId-

getPageByName(string)

Ruft eine Berichtsseite anhand des Namens ab.

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

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

Parameter

pageName: string

Gibt zurück

Promise<Page>

Geerbt vonReport.getPageByName

getTheme()

Abrufen des Designs des Berichts

report.getTheme();

function getTheme(): Promise<IReportTheme>

Gibt zurück

Promise<IReportTheme>

Geerbt vonReport.getTheme

getZoom()

Gibt den aktuellen Zoomfaktor des Berichts zurück.

function getZoom(): Promise<number>

Gibt zurück

Promise<number>

Geerbt vonReport.getZoom-

isSaved()

überprüft, ob der Bericht gespeichert wird.

report.isSaved()

function isSaved(): Promise<boolean>

Gibt zurück

Promise<boolean>

vonReport.isSaved

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

Aktualisiert die Position eines visuellen Elements auf einer Seite.

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

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

Parameter

pageName: string

visualName: string

x: number

y: number

z: number

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

geerbt vonReport.moveVisual-

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

Entfernt einen oder mehrere Ereignishandler aus der Liste der Handler. Wenn ein Verweis auf die vorhandene Handle-Funktion angegeben ist, entfernen Sie den spezifischen Handler. Wenn der Handler nicht angegeben ist, entfernen Sie alle Handler für den angegebenen Ereignisnamen.

report.off('pageChanged')

or

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

report.off('pageChanged', logHandler);

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

Parameter

eventName: string

handler: IEventHandler<T>

vonReport.off geerbt

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

Fügt einen Ereignishandler für ein bestimmtes Ereignis hinzu.

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

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

Parameter

eventName: string

handler: IEventHandler<T>

vonReport.on geerbt

print()

Druckt die aktive Seite des Berichts, indem sie window.print() in die Komponente "iframe einbetten" aufruft.

function print(): Promise<void>

Gibt zurück

Promise<void>

vonReport.print geerbt

refresh()

Aktualisiert Datenquellen für den Bericht.

report.refresh();

function refresh(): Promise<void>

Gibt zurück

Promise<void>

geerbt vonReport.refresh-

reload()

Lädt das Einbetten mithilfe einer vorhandenen Konfiguration neu. Für Berichte werden dadurch beispielsweise alle Filter effektiv gelöscht und die erste Seite aktiv, die das Zurücksetzen eines Berichts auf den geladenen Zustand simuliert.

report.reload();

function reload(): Promise<void>

Gibt zurück

Promise<void>

geerbt vonReport.reload

removeComponentTabIndex(number)

Entfernt das Tabindex-Attribut des Elements.

function removeComponentTabIndex(_tabIndex?: number)

Parameter

_tabIndex: number

Geerbt vonReport.removeComponentTabIndex-

removeContextMenuCommand(string, string)

Befehl "Kontextmenüerweiterung entfernen".

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

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

Parameter

commandName: string

contextMenuTitle: string

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

Geerbt vonReport.removeContextMenuCommand

removeOptionsMenuCommand(string, string)

Menüerweiterungsbefehl "Optionen entfernen".

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

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

Parameter

commandName: string

optionsMenuTitle: string

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

Geerbt vonReport.removeOptionsMenuCommand-

renamePage(string, string)

Umbenennen einer Seite aus einem Bericht

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

Parameter

pageName: string

displayName: string

Gibt zurück

Promise<void>

geerbt vonReport.renamePage-

resetPersistentFilters()

Zurücksetzen der Filter, Datenschnitte und anderer Datenansichtsänderungen des Benutzers auf den Standardzustand des Berichts

report.resetPersistentFilters();

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

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

Geerbt vonReport.resetPersistentFilters

resetTheme()

Zurücksetzen und Anwenden des Standarddesigns des Berichts

report.resetTheme();

function resetTheme(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonReport.resetTheme

resizeActivePage(PageSizeType, number, number)

Aktualisiert die Größe der aktiven Seite im Bericht.

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

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

Parameter

pageSizeType: PageSizeType

width: number

height: number

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

Geerbt vonReport.resizeActivePage-

resizeVisual(string, string, number, number)

Ändern Sie die Größe eines visuellen Elements auf einer Seite.

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

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

Parameter

pageName: string

visualName: string

width: number

height: number

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

Geerbt vonReport.resizeVisual-

save()

Speichert den Bericht.

function save(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonReport.save

saveAs(ISaveAsParameters)

SaveAs-Bericht.

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

Parameter

saveAsParameters: ISaveAsParameters

Gibt zurück

Promise<void>

Geerbt vonReport.saveAs

savePersistentFilters()

Speichern der Filter, Datenschnitte und anderer Datenansichtsänderungen des Berichts

report.savePersistentFilters();

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

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

Geerbt vonReport.savePersistentFilters

setAccessToken(string)

Legen Sie accessToken fest.

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

Parameter

accessToken: string

Gibt zurück

Promise<void>

geerbt vonReport.setAccessToken

setComponentTabIndex(number)

Tabindex-Attribut des Sets-Elements

function setComponentTabIndex(tabIndex?: number)

Parameter

tabIndex: number

Geerbt vonReport.setComponentTabIndex-

setComponentTitle(string)

Legen Sie den Komponententitel für Barrierefreiheit fest. Bei iframes ändert diese Methode den iframe-Titel.

function setComponentTitle(title: string)

Parameter

title: string

Geerbt vonReport.setComponentTitle-

setVisualDisplayState(string, string, VisualContainerDisplayMode)

Aktualisiert den Anzeigezustand eines visuellen Elements auf einer Seite.

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

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

Parameter

pageName: string

visualName: string

displayState: VisualContainerDisplayMode

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

Geerbt vonReport.setVisualDisplayState

setZoom(number)

Legt den Zoomfaktor des Berichts fest.

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

Parameter

zoomLevel: number

Festzulegende Zoomstufe

Gibt zurück

Promise<void>

Geerbt vonReport.setZoom-

switchLayout(LayoutType)

Aktualisiert das Berichtslayout.

report.switchLayout(layoutType);

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

Parameter

layoutType: LayoutType

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

geerbt vonReport.switchLayout-

switchMode(string | ViewMode)

Wechseln des Berichtsansichtsmodus.

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

Parameter

viewMode: string | ViewMode

Gibt zurück

Promise<void>

Geerbt vonReport.switchMode-

updateSettings(ISettings)

Aktualisiert die Sichtbarkeitseinstellungen für den Filterbereich und den Seitennavigationsbereich.

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

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

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

Parameter

settings: ISettings

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

vonReport.updateSettings geerbt

Freigeben über

Visual class

Geerbte Eigenschaften

Methoden

Geerbte Methoden

Geerbte Eigenschaftsdetails

bookmarksManager

Eigenschaftswert

Details zur Methode

getFilters(FiltersLevel)

Parameter

Gibt zurück

getPages()

Gibt zurück

getVisualDescriptor()

Gibt zurück

removeFilters(FiltersLevel)

Parameter

Gibt zurück

setFilters(IFilter[], FiltersLevel)

Parameter

Gibt zurück

setPage(string)

Parameter

Gibt zurück

updateFilters(FiltersOperations, IFilter[], FiltersLevel)

Parameter

Gibt zurück

Details zur geerbten Methode

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

Parameter

Gibt zurück

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

Parameter

Gibt zurück

addPage(string)

Parameter

Gibt zurück

applyTheme(IReportTheme)

Parameter

Gibt zurück

arePersistentFiltersApplied()

Gibt zurück

clearSelectedVisuals(boolean)

Parameter

Gibt zurück

closeAllOverlays()

Gibt zurück

configChanged(boolean)

Parameter

deletePage(string)

Parameter

Gibt zurück

exitFullscreen()

fullscreen()

getActivePage()

Gibt zurück

getCorrelationId()

Gibt zurück

getId()

Gibt zurück

getPageByName(string)

Parameter

Gibt zurück

getTheme()

Gibt zurück

getZoom()

Gibt zurück

isSaved()

Gibt zurück

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

Parameter

Gibt zurück

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

Parameter

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

Parameter

print()

Gibt zurück

refresh()