Visual class

bookmarksManager: BookmarksManager

Egenskapsvärde

ärvd frånReport.bookmarksManager

Hämtar filter som tillämpas på filternivån. Standardfilternivån är visuell nivå.

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

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

Parametrar

Returer

Hämtar listan över sidor i rapporten – stöds inte i visuella objekt

function getPages(): Promise<Page[]>

Returer

Hämtar det inbäddade visuella deskriptorobjektet som innehåller det visuella namnet, typen osv.

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

function getVisualDescriptor(): Promise<VisualDescriptor>

Returer

Tar bort alla filter från den aktuella filternivån. Standardfilternivån är visuell nivå.

visual.removeFilters(filtersLevel);

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

Parametrar

Returer

Anger filter på filternivå. Standardfilternivån är visuell nivå.

const filters: [
   ...
];

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

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

Parametrar

Returer

Anger den aktiva sidan i rapporten – stöds inte i visuella objekt

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

Parametrar

Returer

Uppdaterar filter på filternivå. Standardfilternivån är visuell nivå.

const filters: [
   ...
];

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

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

Parametrar

Returer

Lägg till snabbmenytilläggskommando.

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

Parametrar

Returer

ärvd frånReport.addContextMenuCommand

Lägg till menytilläggskommando för alternativ.

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

Parametrar

Returer

ärvd frånReport.addOptionsMenuCommand

Lägg till en tom sida i rapporten

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

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

Parametrar

Returer

ärvd frånReport.addPage

Använda ett tema i rapporten

report.applyTheme(theme);

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

Parametrar

Returer

ärvd frånReport.applyTheme

Returnerar om det finns användarens filter, utsnitt eller andra ändringar i datavyn som tillämpas på rapporten. Om beständiga filter är inaktiverade returneras false.

report.arePersistentFiltersApplied();

function arePersistentFiltersApplied(): Promise<boolean>

Returer

ärvd frånReport.arePersistentFiltersApplied

Avmarkerar markerade visuella objekt som inte har poppats ut. Om flaggan skickas rensas alla visuella objektval.

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

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

Parametrar

Returer

ärvd frånReport.clearSelectedVisuals

Stänger alla öppna snabbmenyer och knappbeskrivningar.

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

function closeAllOverlays(): Promise<void>

Returer

ärvs frånReport.closeAllOverlays

Hantera konfigurationsändringar.

function configChanged(isBootstrap: boolean)

Parametrar

ärvd frånReport.configChanged

Ta bort en sida från en rapport

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

Parametrar

Returer

ärvd frånReport.deletePage

Begär att webbläsaren avslutar fullskärmsläget.

function exitFullscreen()

ärvd frånReport.exitFullscreen

Begär att webbläsaren ska återge komponentens iframe i fullskärmsläge.

function fullscreen()

ärvd frånReport.fullscreen

Hämtar den aktiva rapportsidan.

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

function getActivePage(): Promise<Page>

Returer

ärvd frånReport.getActivePage

Hämta correlationId för den aktuella inbäddningssessionen.

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

function getCorrelationId(): Promise<string>

Returer

ärvd frånReport.getCorrelationId

Hämtar rapport-ID:t från den första tillgängliga platsen: alternativ, attribut, inbäddnings-URL.

function getId(): string

Returer

ärvd frånReport.getId

Hämtar en rapportsida med dess namn.

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

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

Parametrar

Returer

ärvd frånReport.getPageByName

hämta rapportens tema

report.getTheme();

function getTheme(): Promise<IReportTheme>

Returer

ärvd frånReport.getTheme

Returnera rapportens aktuella zoomnivå.

function getZoom(): Promise<number>

Returer

ärvd frånReport.getZoom

kontrollerar om rapporten sparas.

report.isSaved()

function isSaved(): Promise<boolean>

Returer

ärvs frånReport.isSaved

Uppdaterar positionen för ett visuellt objekt på en sida.

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

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

Parametrar

Returer

ärvs frånReport.moveVisual

Tar bort en eller flera händelsehanterare från listan över hanterare. Om en referens till den befintliga referensfunktionen har angetts tar du bort den specifika hanteraren. Om hanteraren inte har angetts tar du bort alla hanterare för det angivna händelsenamnet.

report.off('pageChanged')

or

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

report.off('pageChanged', logHandler);

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

Parametrar

ärvd frånReport.off

Lägger till en händelsehanterare för en viss händelse.

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

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

Parametrar

ärvd frånReport.on

Skriver ut den aktiva sidan i rapporten genom att anropa window.print() på komponenten embed iframe.

function print(): Promise<void>

Returer

ärvd frånReport.print

Uppdaterar datakällor för rapporten.

report.refresh();

function refresh(): Promise<void>

Returer

ärvs frånReport.refresh

Läser in inbäddningen igen med hjälp av befintlig konfiguration. T.ex. För rapporter rensar detta effektivt alla filter och gör den första sidan aktiv som simulerar återställning av en rapport tillbaka till inläst tillstånd.

report.reload();

function reload(): Promise<void>

Returer

ärvs frånReport.reload

Tar bort elementets tabindexattribut

function removeComponentTabIndex(_tabIndex?: number)

Parametrar

ärvd frånReport.removeComponentTabIndex

Ta bort kommandot för snabbmenytillägg.

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

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

Parametrar

Returer

ärvd frånReport.removeContextMenuCommand

Kommandot Ta bort alternativ för menytillägg.

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

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

Parametrar

Returer

ärvd frånReport.removeOptionsMenuCommand

Byt namn på en sida från en rapport

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

Parametrar

Returer

ärvd frånReport.renamePage

Återställa användarens filter, utsnitt och andra datavyändringar till standardtillståndet för rapporten

report.resetPersistentFilters();

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

Returer

ärvs frånReport.resetPersistentFilters

Återställa och tillämpa standardtemat i rapporten

report.resetTheme();

function resetTheme(): Promise<void>

Returer

ärvs frånReport.resetTheme

Uppdaterar storleken på den aktiva sidan i rapporten.

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

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

Parametrar

Returer

ärvs frånReport.resizeActivePage

Ändra storlek på ett visuellt objekt på en sida.

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

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

Parametrar

Returer

ärvs frånReport.resizeVisual

Sparar rapport.

function save(): Promise<void>

Returer

ärvs frånReport.save

SaveAs-rapport.

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

Parametrar

Returer

ärvs frånReport.saveAs

Spara användarens filter, utsnitt och andra ändringar i datavyn i rapporten

report.savePersistentFilters();

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

Returer

ärvs frånReport.savePersistentFilters

Ange accessToken.

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

Parametrar

Returer

ärvd frånReport.setAccessToken

Anger elementets tabindexattribut

function setComponentTabIndex(tabIndex?: number)

Parametrar

ärvd frånReport.setComponentTabIndex

Ange komponentrubriken för hjälpmedel. Om det gäller iframes ändrar den här metoden iframe-rubriken.

function setComponentTitle(title: string)

Parametrar

Ärvd frånReport.setComponentTitle

Uppdaterar visningstillståndet för ett visuellt objekt på en sida.

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

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

Parametrar

Returer

Ärvd frånReport.setVisualDisplayState

Anger rapportens zoomnivå.

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

Parametrar

Returer

ärvd frånReport.setZoom

Uppdaterar rapportlayouten

report.switchLayout(layoutType);

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

Parametrar

Returer

ärvs frånReport.switchLayout

Växla rapportvyläge.

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

Parametrar

Returer

ärvd frånReport.switchMode

Uppdaterar synlighetsinställningarna för filterfönstret och sidnavigeringsfönstret.

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

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

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

Parametrar

Returer

ärvs frånReport.updateInställningar