Visual class

bookmarksManager: BookmarksManager

Property Value

Inherited From Report.bookmarksManager

Gets filters that are applied to the filter level. Default filter level is visual level.

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

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

Parameters

Returns

Gets the list of pages within the report - not supported in visual

function getPages(): Promise<Page[]>

Returns

Gets the embedded visual descriptor object that contains the visual name, type, etc.

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

function getVisualDescriptor(): Promise<VisualDescriptor>

Returns

Removes all filters from the current filter level. Default filter level is visual level.

visual.removeFilters(filtersLevel);

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

Parameters

Returns

Sets filters at the filter level. Default filter level is visual level.

const filters: [
   ...
];

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

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

Parameters

Returns

Sets the active page of the report - not supported in visual

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

Parameters

Returns

Updates filters at the filter level. Default filter level is visual level.

const filters: [
   ...
];

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

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

Parameters

Returns

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

Parameters

Returns

Inherited From Report.addContextMenuCommand

Add options menu extension command.

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

Parameters

Returns

Inherited From Report.addOptionsMenuCommand

Add an empty page to the report

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

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

Parameters

Returns

Inherited From Report.addPage

Apply a theme to the report

report.applyTheme(theme);

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

Parameters

Returns

Inherited From Report.applyTheme

Returns if there are user's filters, slicers, or other data view changes applied on the report. If persistent filters is disable, returns false.

report.arePersistentFiltersApplied();

function arePersistentFiltersApplied(): Promise<boolean>

Returns

Inherited From Report.arePersistentFiltersApplied

Clears selected not popped out visuals, if flag is passed, all visuals selections will be cleared.

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

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

Parameters

Returns

Inherited From Report.clearSelectedVisuals

Closes all open context menus and tooltips.

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

function closeAllOverlays(): Promise<void>

Returns

Inherited From Report.closeAllOverlays

Handle config changes.

function configChanged(isBootstrap: boolean)

Parameters

Inherited From Report.configChanged

Delete a page from a report

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

Parameters

Returns

Inherited From Report.deletePage

Requests the browser to exit fullscreen mode.

function exitFullscreen()

Inherited From Report.exitFullscreen

Requests the browser to render the component's iframe in fullscreen mode.

function fullscreen()

Inherited From Report.fullscreen

Gets the active report page.

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

function getActivePage(): Promise<Page>

Returns

Inherited From Report.getActivePage

Get the correlationId for the current embed session.

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

function getCorrelationId(): Promise<string>

Returns

Inherited From Report.getCorrelationId

Gets the report ID from the first available location: options, attribute, embed url.

function getId(): string

Returns

Inherited From Report.getId

Gets a report page by its name.

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

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

Parameters

Returns

Inherited From Report.getPageByName

get the theme of the report

report.getTheme();

function getTheme(): Promise<IReportTheme>

Returns

Inherited From Report.getTheme

Return the current zoom level of the report.

function getZoom(): Promise<number>

Returns

Inherited From Report.getZoom

checks if the report is saved.

report.isSaved()

function isSaved(): Promise<boolean>

Returns

Inherited From Report.isSaved

Updates the position of a visual in a page.

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

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

Parameters

Returns

Inherited From Report.moveVisual

Removes one or more event handlers from the list of handlers. If a reference to the existing handle function is specified, remove the specific handler. If the handler is not specified, remove all handlers for the event name specified.

report.off('pageChanged')

or

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

report.off('pageChanged', logHandler);

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

Parameters

Inherited From Report.off

Adds an event handler for a specific event.

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

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

Parameters

Inherited From Report.on

Prints the active page of the report by invoking window.print() on the embed iframe component.

function print(): Promise<void>

Returns

Inherited From Report.print

Refreshes data sources for the report.

report.refresh();

function refresh(): Promise<void>

Returns

Inherited From Report.refresh

Reloads embed using existing configuration. E.g. For reports this effectively clears all filters and makes the first page active which simulates resetting a report back to loaded state.

report.reload();

function reload(): Promise<void>

Returns

Inherited From Report.reload

Removes element's tabindex attribute

function removeComponentTabIndex(_tabIndex?: number)

Parameters

Inherited From Report.removeComponentTabIndex

Remove context menu extension command.

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

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

Parameters

Returns

Inherited From Report.removeContextMenuCommand

Remove options menu extension command.

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

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

Parameters

Returns

Inherited From Report.removeOptionsMenuCommand

Rename a page from a report

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

Parameters

Returns

Inherited From Report.renamePage

Reset user's filters, slicers, and other data view changes to the default state of the report

report.resetPersistentFilters();

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

Returns

Inherited From Report.resetPersistentFilters

Reset and apply the default theme of the report

report.resetTheme();

function resetTheme(): Promise<void>

Returns

Inherited From Report.resetTheme

Updates the size of active page in report.

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

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

Parameters

Returns

Inherited From Report.resizeActivePage

Resize a visual in a page.

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

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

Parameters

Returns

Inherited From Report.resizeVisual

Saves Report.

function save(): Promise<void>

Returns

Inherited From Report.save

SaveAs Report.

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

Parameters

Returns

Inherited From Report.saveAs

Save user's filters, slicers, and other data view changes of the report

report.savePersistentFilters();

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

Returns

Inherited From Report.savePersistentFilters

Set accessToken.

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

Parameters

Returns

Inherited From Report.setAccessToken

Sets element's tabindex attribute

function setComponentTabIndex(tabIndex?: number)

Parameters

Inherited From Report.setComponentTabIndex

Set the component title for accessibility. In case of iframes, this method will change the iframe title.

function setComponentTitle(title: string)

Parameters

Inherited From Report.setComponentTitle

Updates the display state of a visual in a page.

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

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

Parameters

Returns

Inherited From Report.setVisualDisplayState

Sets the report's zoom level.

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

Parameters

Returns

Inherited From Report.setZoom

Updates the report layout

report.switchLayout(layoutType);

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

Parameters

Returns

Inherited From Report.switchLayout

Switch Report view mode.

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

Parameters

Returns

Inherited From Report.switchMode

Updates visibility settings for the filter pane and the page navigation pane.

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

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

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

Parameters

Returns

Inherited From Report.updateSettings