Visual class

bookmarksManager: BookmarksManager

属性值

继承自Report.bookmarksManager

获取应用于筛选器级别的筛选器。 默认筛选器级别为视觉级别。

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

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

参数

返回

获取报表中的页面列表 - 视觉对象中不支持

function getPages(): Promise<Page[]>

返回

获取包含视觉对象名称、类型等的嵌入式视觉描述符对象。

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

function getVisualDescriptor(): Promise<VisualDescriptor>

返回

从当前筛选器级别删除所有筛选器。 默认筛选器级别为视觉级别。

visual.removeFilters(filtersLevel);

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

参数

返回

在筛选器级别设置筛选器。 默认筛选器级别为视觉级别。

const filters: [
   ...
];

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

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

参数

返回

设置报表的活动页 - 视觉对象不支持

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

参数

返回

更新筛选器级别的筛选器。 默认筛选器级别为视觉级别。

const filters: [
   ...
];

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

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

参数

返回

添加上下文菜单扩展命令。

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

参数

返回

继承自Report.addContextMenuCommand

添加选项菜单扩展命令。

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

参数

返回

继承自Report.addOptionsMenuCommand

向报表添加空页

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

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

参数

返回

继承自Report.addPage

将主题应用于报表

report.applyTheme(theme);

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

参数

返回

继承自Report.applyTheme

如果报表上应用了用户的筛选器、切片器或其他数据视图更改，则返回。 如果永久筛选器处于禁用状态，则返回 false。

report.arePersistentFiltersApplied();

function arePersistentFiltersApplied(): Promise<boolean>

返回

继承自Report.arePersistentFiltersApplied

清除所选的未弹出视觉对象，如果传递标志，将清除所有视觉对象选择。

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

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

参数

返回

继承自Report.clearSelectedVisuals

关闭所有打开的上下文菜单和工具提示。

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

function closeAllOverlays(): Promise<void>

返回

继承自report.closeAllOverlays

处理配置更改。

function configChanged(isBootstrap: boolean)

参数

继承自 report.configChanged 的

从报表中删除页面

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

参数

返回

继承自Report.deletePage

请求浏览器退出全屏模式。

function exitFullscreen()

继承自Report.exitFullscreen

请求浏览器以全屏模式呈现组件的 iframe。

function fullscreen()

继承自Report.fullscreen

获取活动报表页。

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

function getActivePage(): Promise<Page>

返回

继承自Report.getActivePage

获取当前嵌入会话的 correlationId。

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

function getCorrelationId(): Promise<string>

返回

继承自Report.getCorrelationId

从第一个可用位置获取报表 ID：选项、属性、嵌入 URL。

function getId(): string

返回

继承自Report.getId

按报表页的名称获取报表页。

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

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

参数

返回

继承自Report.getPageByName

获取报表的主题

report.getTheme();

function getTheme(): Promise<IReportTheme>

返回

继承自Report.getTheme

返回报表的当前缩放级别。

function getZoom(): Promise<number>

返回

继承自Report.getZoom

检查报表是否已保存。

report.isSaved()

function isSaved(): Promise<boolean>

返回

继承自Report.isSaved

更新视觉对象在页面中的位置。

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

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

参数

返回

继承自Report.moveVisual

从处理程序列表中删除一个或多个事件处理程序。 如果指定了对现有句柄函数的引用，请删除特定的处理程序。 如果未指定处理程序，请删除指定事件名称的所有处理程序。

report.off('pageChanged')

or

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

report.off('pageChanged', logHandler);

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

参数

继承自Report.off

为特定事件添加事件处理程序。

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

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

参数

继承自Report.on

通过在嵌入 iframe 组件上调用 window.print() 来打印报表的活动页。

function print(): Promise<void>

返回

继承自Report.print

刷新报表的数据源。

report.refresh();

function refresh(): Promise<void>

返回

继承自Report.refresh

使用现有配置重新加载嵌入。 例如，对于报表，这会有效地清除所有筛选器，并使第一页处于活动状态，从而模拟将报表重置回加载状态。

report.reload();

function reload(): Promise<void>

返回

继承自Report.reload

删除元素的 tabindex 属性

function removeComponentTabIndex(_tabIndex?: number)

参数

继承自Report.removeComponentTabIndex

删除上下文菜单扩展命令。

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

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

参数

返回

继承自Report.removeContextMenuCommand

删除选项菜单扩展命令。

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

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

参数

返回

继承自Report.removeOptionsMenuCommand

从报表重命名页面

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

参数

返回

继承自Report.renamePage

将用户的筛选器、切片器和其他数据视图更改重置为报表的默认状态

report.resetPersistentFilters();

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

返回

继承自Report.resetPersistentFilters

重置并应用报表的默认主题

report.resetTheme();

function resetTheme(): Promise<void>

返回

继承自Report.resetTheme

更新报表中活动页的大小。

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

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

参数

返回

继承自Report.resizeActivePage

调整页面中的视觉对象的大小。

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

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

参数

返回

继承自Report.resizeVisual

保存报表。

function save(): Promise<void>

返回

继承自Report.save

SaveAs 报表。

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

参数

返回

继承自Report.saveAs

保存用户的筛选器、切片器和其他报表数据视图更改

report.savePersistentFilters();

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

返回

继承自Report.savePersistentFilters

设置 accessToken。

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

参数

返回

继承自report.setAccessToken

设置元素的 tabindex 属性

function setComponentTabIndex(tabIndex?: number)

参数

继承自Report.setComponentTabIndex

设置辅助功能的组件标题。 对于 iframe，此方法将更改 iframe 标题。

function setComponentTitle(title: string)

参数

继承自Report.setComponentTitle

更新页面中视觉对象的显示状态。

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

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

参数

返回

继承自report.setVisualDisplayState

设置报表的缩放级别。

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

参数

返回

继承自Report.setZoom

更新报表布局

report.switchLayout(layoutType);

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

参数

返回

继承自Report.switchLayout

切换报表视图模式。

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

参数

返回

继承自Report.switchMode

更新筛选器窗格和页面导航窗格的可见性设置。

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

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

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

参数

返回

继承自Report.updateSettings