Поделиться через


Visual class

Компонент внедрения Visual Power BI

Extends

Унаследованные свойства

bookmarksManager

Методы

getFilters(FiltersLevel)

Возвращает фильтры, применяемые к уровню фильтра. Уровень фильтра по умолчанию — это визуальный уровень.

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

Возвращает список страниц в отчете — не поддерживается в визуальном элементе.

getVisualDescriptor()

Возвращает внедренный объект дескриптора визуального элемента, содержащий визуальное имя, тип и т. д.

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

Удаляет все фильтры из текущего уровня фильтра. Уровень фильтра по умолчанию — это визуальный уровень.

visual.removeFilters(filtersLevel);
setFilters(IFilter[], FiltersLevel)

Задает фильтры на уровне фильтра. Уровень фильтра по умолчанию — это визуальный уровень.

const filters: [
   ...
];

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

Задает активную страницу отчета — не поддерживается в визуальном элементе

updateFilters(FiltersOperations, IFilter[], FiltersLevel)

Обновляет фильтры на уровне фильтра. Уровень фильтра по умолчанию — это визуальный уровень.

const filters: [
   ...
];

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

Наследуемые методы

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

Добавьте команду расширения контекстного меню.

report.addContextMenuCommand(commandName, commandTitle, contextMenuTitle, menuLocation, visualName, visualType, groupName)
 .catch(error => {
     ...
 });
addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)

Добавьте команду расширения меню параметров.

report.addOptionsMenuCommand(commandName, commandTitle, optionsMenuTitle, menuLocation, visualName, visualType, groupName, commandIcon)
 .catch(error => {
     ...
 });
addPage(string)

Добавление пустой страницы в отчет

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

Применение темы к отчету

report.applyTheme(theme);
arePersistentFiltersApplied()

Возвращает значение, если в отчете применяются фильтры, срезы или другие изменения представления данных. Если постоянные фильтры отключены, возвращает значение false.

report.arePersistentFiltersApplied();
clearSelectedVisuals(boolean)

Очищает выбранные визуальные элементы, если флаг передается, будут сняты все выбранные визуальные элементы.

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

Закрывает все открытые контекстные меню и подсказки.

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

Обработка изменений конфигурации.

deletePage(string)

Удаление страницы из отчета

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

Запрашивает браузер для выхода из полноэкранного режима.

fullscreen()

Запрашивает браузер отрисовку iframe компонента в полноэкранном режиме.

getActivePage()

Возвращает активную страницу отчета.

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

Получите идентификатор корреляции для текущего сеанса внедрения.

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

Возвращает идентификатор отчета из первого доступного расположения: параметры, атрибут, URL-адрес внедрения.

getPageByName(string)

Возвращает страницу отчета по имени.

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

Получение темы отчета

report.getTheme();
getZoom()

Возвращает текущий уровень масштабирования отчета.

isSaved()

проверяет, сохранен ли отчет.

report.isSaved()
moveVisual(string, string, number, number, number)

Обновляет положение визуального элемента на странице.

report.moveVisual(pageName, visualName, x, y, z)
  .catch(error => { ... });
off<T>(string, IEventHandler<T>)

Удаляет один или несколько обработчиков событий из списка обработчиков. Если указана ссылка на существующую функцию дескриптора, удалите конкретный обработчик. Если обработчик не указан, удалите все обработчики для указанного имени события.

report.off('pageChanged')

or

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

report.off('pageChanged', logHandler);
on<T>(string, IEventHandler<T>)

Добавляет обработчик событий для определенного события.

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

Выводит активную страницу отчета, вызывая window.print() на компоненте iframe внедрения.

refresh()

Обновляет источники данных для отчета.

report.refresh();
reload()

Перезагрузит внедрение с помощью существующей конфигурации. Например, для отчетов это эффективно очищает все фильтры и делает первую страницу активной, которая имитирует сброс отчета обратно в загруженное состояние.

report.reload();
removeComponentTabIndex(number)

Удаляет атрибут tabindex элемента

removeContextMenuCommand(string, string)

Удалите команду расширения контекстного меню.

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

Удалить команду расширения меню параметров.

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

Переименование страницы из отчета

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

Сброс фильтров, срезов и других представлений данных в состояние отчета по умолчанию

report.resetPersistentFilters();
resetTheme()

Сброс и применение темы отчета по умолчанию

report.resetTheme();
resizeActivePage(PageSizeType, number, number)

Обновляет размер активной страницы в отчете.

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

Изменение размера визуального элемента на странице.

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

Сохраняет отчет.

saveAs(ISaveAsParameters)

Отчет SaveAs.

savePersistentFilters()

Сохранение фильтров, срезов и других изменений представления данных отчета

report.savePersistentFilters();
setAccessToken(string)

Задайте accessToken.

setComponentTabIndex(number)

Задает атрибут tabindex элемента

setComponentTitle(string)

Задайте заголовок компонента для специальных возможностей. В случае iframe этот метод изменит заголовок iframe.

setVisualDisplayState(string, string, VisualContainerDisplayMode)

Обновляет состояние отображения визуального элемента на странице.

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

Задает уровень масштабирования отчета.

switchLayout(LayoutType)

Обновляет макет отчета

report.switchLayout(layoutType);
switchMode(string | ViewMode)

Переключение режима представления отчета.

updateSettings(ISettings)

Обновляет параметры видимости для области фильтров и области навигации по страницам.

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

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

Сведения об унаследованном свойстве

bookmarksManager

bookmarksManager: BookmarksManager

Значение свойства

наследуется отReport.bookmarksManager

Сведения о методе

getFilters(FiltersLevel)

Возвращает фильтры, применяемые к уровню фильтра. Уровень фильтра по умолчанию — это визуальный уровень.

visual.getFilters(filtersLevel)
  .then(filters => {
    ...
  });
function getFilters(filtersLevel?: FiltersLevel): Promise<IFilter[]>

Параметры

filtersLevel
FiltersLevel

Возвращаемое значение

Promise<IFilter[]>

getPages()

Возвращает список страниц в отчете — не поддерживается в визуальном элементе.

function getPages(): Promise<Page[]>

Возвращаемое значение

Promise<Page[]>

getVisualDescriptor()

Возвращает внедренный объект дескриптора визуального элемента, содержащий визуальное имя, тип и т. д.

visual.getVisualDescriptor()
  .then(visualDetails => { ... });
function getVisualDescriptor(): Promise<VisualDescriptor>

Возвращаемое значение

Promise<VisualDescriptor>

removeFilters(FiltersLevel)

Удаляет все фильтры из текущего уровня фильтра. Уровень фильтра по умолчанию — это визуальный уровень.

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

Параметры

filtersLevel
FiltersLevel

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[], FiltersLevel)

Задает фильтры на уровне фильтра. Уровень фильтра по умолчанию — это визуальный уровень.

const filters: [
   ...
];

visual.setFilters(filters, filtersLevel)
 .catch(errors => {
   ...
 });
function setFilters(filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>

Параметры

filters

IFilter[]

filtersLevel
FiltersLevel

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

setPage(string)

Задает активную страницу отчета — не поддерживается в визуальном элементе

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

Параметры

_pageName

string

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[], FiltersLevel)

Обновляет фильтры на уровне фильтра. Уровень фильтра по умолчанию — это визуальный уровень.

const filters: [
   ...
];

visual.updateFilters(FiltersOperations.Add, filters, filtersLevel)
 .catch(errors => {
   ...
 });
function updateFilters(operation: FiltersOperations, filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>

Параметры

operation
FiltersOperations
filters

IFilter[]

filtersLevel
FiltersLevel

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

Сведения о наследуемом методе

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

Добавьте команду расширения контекстного меню.

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

Параметры

commandName

string

commandTitle

string

contextMenuTitle

string

menuLocation
MenuLocation
visualName

string

visualType

string

groupName

string

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

наследуется отReport.addContextMenuCommand

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

Добавьте команду расширения меню параметров.

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

Параметры

commandName

string

commandTitle

string

optionsMenuTitle

string

menuLocation
MenuLocation
visualName

string

visualType

string

groupName

string

commandIcon

string

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

наследуется отReport.addOptionsMenuCommand

addPage(string)

Добавление пустой страницы в отчет

// Add a page to the report with "Sales" as the page display name
report.addPage("Sales");
function addPage(displayName?: string): Promise<Page>

Параметры

displayName

string

Возвращаемое значение

Promise<Page>

наследуется отReport.addPage

applyTheme(IReportTheme)

Применение темы к отчету

report.applyTheme(theme);
function applyTheme(theme: IReportTheme): Promise<void>

Параметры

theme
IReportTheme

Возвращаемое значение

Promise<void>

наследуется отReport.applyTheme

arePersistentFiltersApplied()

Возвращает значение, если в отчете применяются фильтры, срезы или другие изменения представления данных. Если постоянные фильтры отключены, возвращает значение false.

report.arePersistentFiltersApplied();
function arePersistentFiltersApplied(): Promise<boolean>

Возвращаемое значение

Promise<boolean>

унаследован от отчета.arePersistentFiltersApplied

clearSelectedVisuals(boolean)

Очищает выбранные визуальные элементы, если флаг передается, будут сняты все выбранные визуальные элементы.

report.clearSelectedVisuals()
 .then(() => {
     ...
 });
function clearSelectedVisuals(clearPopOutState?: boolean): Promise<void>

Параметры

clearPopOutState

boolean

Если выделение ложных или неопределенных визуальных элементов не будет снято, если один из визуальных элементов находится в состоянии "выскочил" (в фокусе, отображается как таблица, в центре внимания...)

Возвращаемое значение

Promise<void>

унаследован отReport.clearSelectedVisuals

closeAllOverlays()

Закрывает все открытые контекстные меню и подсказки.

report.closeAllOverlays()
 .then(() => {
     ...
 });
function closeAllOverlays(): Promise<void>

Возвращаемое значение

Promise<void>

унаследован отReport.closeAllOverlays

configChanged(boolean)

Обработка изменений конфигурации.

function configChanged(isBootstrap: boolean)

Параметры

isBootstrap

boolean

унаследован отReport.configChanged

deletePage(string)

Удаление страницы из отчета

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

Параметры

pageName

string

Возвращаемое значение

Promise<void>

наследуется отReport.deletePage

exitFullscreen()

Запрашивает браузер для выхода из полноэкранного режима.

function exitFullscreen()

унаследован отReport.exitFullscreen

fullscreen()

Запрашивает браузер отрисовку iframe компонента в полноэкранном режиме.

function fullscreen()

унаследован отReport.fullscreen

getActivePage()

Возвращает активную страницу отчета.

report.getActivePage()
 .then(activePage => {
     ...
 });
function getActivePage(): Promise<Page>

Возвращаемое значение

Promise<Page>

наследуется отReport.getActivePage

getCorrelationId()

Получите идентификатор корреляции для текущего сеанса внедрения.

// Get the correlationId for the current embed session
report.getCorrelationId()
  .then(correlationId => {
    ...
  });
function getCorrelationId(): Promise<string>

Возвращаемое значение

Promise<string>

наследуется отReport.getCorrelationId

getId()

Возвращает идентификатор отчета из первого доступного расположения: параметры, атрибут, URL-адрес внедрения.

function getId(): string

Возвращаемое значение

string

унаследован отReport.getId

getPageByName(string)

Возвращает страницу отчета по имени.

report.getPageByName(pageName)
 .then(page => {
     ...
 });
function getPageByName(pageName: string): Promise<Page>

Параметры

pageName

string

Возвращаемое значение

Promise<Page>

наследуется отReport.getPageByName

getTheme()

Получение темы отчета

report.getTheme();
function getTheme(): Promise<IReportTheme>

Возвращаемое значение

Promise<IReportTheme>

наследуется отReport.getTheme

getZoom()

Возвращает текущий уровень масштабирования отчета.

function getZoom(): Promise<number>

Возвращаемое значение

Promise<number>

унаследован отReport.getZoom

isSaved()

проверяет, сохранен ли отчет.

report.isSaved()
function isSaved(): Promise<boolean>

Возвращаемое значение

Promise<boolean>

унаследован от отчета.isSaved

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

Обновляет положение визуального элемента на странице.

report.moveVisual(pageName, visualName, x, y, z)
  .catch(error => { ... });
function moveVisual(pageName: string, visualName: string, x: number, y: number, z?: number): Promise<IHttpPostMessageResponse<void>>

Параметры

pageName

string

visualName

string

x

number

y

number

z

number

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

унаследован отReport.moveVisual

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

Удаляет один или несколько обработчиков событий из списка обработчиков. Если указана ссылка на существующую функцию дескриптора, удалите конкретный обработчик. Если обработчик не указан, удалите все обработчики для указанного имени события.

report.off('pageChanged')

or

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

report.off('pageChanged', logHandler);
function off<T>(eventName: string, handler?: IEventHandler<T>)

Параметры

eventName

string

handler

IEventHandler<T>

наследуется отReport.off

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

Добавляет обработчик событий для определенного события.

report.on('pageChanged', (event) => {
  console.log('PageChanged: ', event.page.name);
});
function on<T>(eventName: string, handler: IEventHandler<T>)

Параметры

eventName

string

handler

IEventHandler<T>

унаследован отReport.on

print()

Выводит активную страницу отчета, вызывая window.print() на компоненте iframe внедрения.

function print(): Promise<void>

Возвращаемое значение

Promise<void>

унаследован отReport.print

refresh()

Обновляет источники данных для отчета.

report.refresh();
function refresh(): Promise<void>

Возвращаемое значение

Promise<void>

унаследован отReport.refresh

reload()

Перезагрузит внедрение с помощью существующей конфигурации. Например, для отчетов это эффективно очищает все фильтры и делает первую страницу активной, которая имитирует сброс отчета обратно в загруженное состояние.

report.reload();
function reload(): Promise<void>

Возвращаемое значение

Promise<void>

унаследовано отReport.reload

removeComponentTabIndex(number)

Удаляет атрибут tabindex элемента

function removeComponentTabIndex(_tabIndex?: number)

Параметры

_tabIndex

number

наследуется отReport.removeComponentTabIndex

removeContextMenuCommand(string, string)

Удалите команду расширения контекстного меню.

report.removeContextMenuCommand(commandName, contextMenuTitle)
 .catch(error => {
     ...
 });
function removeContextMenuCommand(commandName: string, contextMenuTitle: string): Promise<IHttpPostMessageResponse<void>>

Параметры

commandName

string

contextMenuTitle

string

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

наследуется отReport.removeContextMenuCommand

removeOptionsMenuCommand(string, string)

Удалить команду расширения меню параметров.

report.removeOptionsMenuCommand(commandName, optionsMenuTitle)
 .then({
     ...
 });
function removeOptionsMenuCommand(commandName: string, optionsMenuTitle: string): Promise<IHttpPostMessageResponse<void>>

Параметры

commandName

string

optionsMenuTitle

string

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

наследуется отReport.removeOptionsMenuCommand

renamePage(string, string)

Переименование страницы из отчета

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

Параметры

pageName

string

displayName

string

Возвращаемое значение

Promise<void>

унаследовано отReport.renamePage

resetPersistentFilters()

Сброс фильтров, срезов и других представлений данных в состояние отчета по умолчанию

report.resetPersistentFilters();
function resetPersistentFilters(): Promise<IHttpPostMessageResponse<void>>

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

наследуется отReport.resetPersistentFilters

resetTheme()

Сброс и применение темы отчета по умолчанию

report.resetTheme();
function resetTheme(): Promise<void>

Возвращаемое значение

Promise<void>

унаследовано отReport.resetTheme

resizeActivePage(PageSizeType, number, number)

Обновляет размер активной страницы в отчете.

report.resizeActivePage(pageSizeType, width, height)
  .catch(error => { ... });
function resizeActivePage(pageSizeType: PageSizeType, width?: number, height?: number): Promise<IHttpPostMessageResponse<void>>

Параметры

pageSizeType
PageSizeType
width

number

height

number

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

унаследован отReport.resizeActivePage

resizeVisual(string, string, number, number)

Изменение размера визуального элемента на странице.

report.resizeVisual(pageName, visualName, width, height)
  .catch(error => { ... });
function resizeVisual(pageName: string, visualName: string, width: number, height: number): Promise<IHttpPostMessageResponse<void>>

Параметры

pageName

string

visualName

string

width

number

height

number

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

унаследован отReport.resizeVisual

save()

Сохраняет отчет.

function save(): Promise<void>

Возвращаемое значение

Promise<void>

наследуется отReport.save

saveAs(ISaveAsParameters)

Отчет SaveAs.

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

Параметры

saveAsParameters
ISaveAsParameters

Возвращаемое значение

Promise<void>

наследуется отReport.saveAs

savePersistentFilters()

Сохранение фильтров, срезов и других изменений представления данных отчета

report.savePersistentFilters();
function savePersistentFilters(): Promise<IHttpPostMessageResponse<void>>

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

наследуется отReport.savePersistentFilters

setAccessToken(string)

Задайте accessToken.

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

Параметры

accessToken

string

Возвращаемое значение

Promise<void>

унаследован отReport.setAccessToken

setComponentTabIndex(number)

Задает атрибут tabindex элемента

function setComponentTabIndex(tabIndex?: number)

Параметры

tabIndex

number

наследуется отReport.setComponentTabIndex

setComponentTitle(string)

Задайте заголовок компонента для специальных возможностей. В случае iframe этот метод изменит заголовок iframe.

function setComponentTitle(title: string)

Параметры

title

string

наследуется отReport.setComponentTitle

setVisualDisplayState(string, string, VisualContainerDisplayMode)

Обновляет состояние отображения визуального элемента на странице.

report.setVisualDisplayState(pageName, visualName, displayState)
  .catch(error => { ... });
function setVisualDisplayState(pageName: string, visualName: string, displayState: VisualContainerDisplayMode): Promise<IHttpPostMessageResponse<void>>

Параметры

pageName

string

visualName

string

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

наследуется отReport.setVisualDisplayState

setZoom(number)

Задает уровень масштабирования отчета.

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

Параметры

zoomLevel

number

Уровень масштабирования для задания

Возвращаемое значение

Promise<void>

унаследован отReport.setZoom

switchLayout(LayoutType)

Обновляет макет отчета

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

Параметры

layoutType
LayoutType

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

унаследован отReport.switchLayout

switchMode(string | ViewMode)

Переключение режима представления отчета.

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

Параметры

viewMode

string | ViewMode

Возвращаемое значение

Promise<void>

унаследован отReport.switchMode

updateSettings(ISettings)

Обновляет параметры видимости для области фильтров и области навигации по страницам.

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

report.updateSettings(newSettings)
  .catch(error => { ... });
function updateSettings(settings: ISettings): Promise<IHttpPostMessageResponse<void>>

Параметры

settings
ISettings

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

унаследован отReport.updateSettings