Report class

Ссылка

Пакет:: powerbi-client

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

Extends: Embed

Свойства

Методы

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");`
getActivePage()	Возвращает активную страницу отчета. `report.getActivePage() .then(activePage => { ... });`
getFilters()	Получает фильтры, применяемые на уровне отчета. `// Get filters applied at report level report.getFilters() .then(filters => { ... });`
getId()	Возвращает идентификатор отчета из первого доступного расположения: параметры, атрибут, URL-адрес внедрения.
getPageByName(string)	Возвращает страницу отчета по имени. `report.getPageByName(pageName) .then(page => { ... });`
getPages()	Возвращает список страниц в отчете. `report.getPages() .then(pages => { ... });`
getTheme()	Получение темы отчета `report.getTheme();`
getZoom()	Возвращает текущий уровень масштабирования отчета.
isSaved()	проверяет, сохранен ли отчет. `report.isSaved()`
moveVisual(string, string, number, number, number)	Обновляет положение визуального элемента на странице. `report.moveVisual(pageName, visualName, x, y, z) .catch(error => { ... });`
print()	Выводит активную страницу отчета, вызывая `window.print()` на компоненте iframe внедрения.
refresh()	Обновляет источники данных для отчета. `report.refresh();`
removeContextMenuCommand(string, string)	Удалите команду расширения контекстного меню. `report.removeContextMenuCommand(commandName, contextMenuTitle) .catch(error => { ... });`
removeFilters()	Удаляет все фильтры на уровне отчета. `report.removeFilters();`
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");`
render(IReportEmbedConfiguration \| IReportLoadConfiguration)	Отрисовка предварительно загруженного отчета с помощью api поэтапного внедрения `// Load report var report = powerbi.load(element, config); ... // Render report report.render()`
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 => { ... });`
savePersistentFilters()	Сохранение фильтров, срезов и других изменений представления данных отчета `report.savePersistentFilters();`
setFilters(IFilter[])	Задает фильтры на уровне отчета. `const filters: [ ... ]; report.setFilters(filters) .catch(errors => { ... });`
setPage(string)	Задает активную страницу отчета. `report.setPage("page2") .catch(error => { ... });`
setVisualDisplayState(string, string, VisualContainerDisplayMode)	Обновляет состояние отображения визуального элемента на странице. `report.setVisualDisplayState(pageName, visualName, displayState) .catch(error => { ... });`
setZoom(number)	Задает уровень масштабирования отчета.
switchLayout(LayoutType)	Обновляет макет отчета `report.switchLayout(layoutType);`
switchMode(string \| ViewMode)	Переключение режима представления отчета.
updateFilters(FiltersOperations, IFilter[])	Обновите фильтры на уровне отчета в соответствии с операцией: добавьте, замените все, замените целевым объектом или удалите. `report.updateFilters(FiltersOperations.Add, filters) .catch(errors => { ... });`
updateSettings(ISettings)	Обновляет параметры видимости для области фильтров и области навигации по страницам. `const newSettings = { panes: { filters: { visible: false } } }; report.updateSettings(newSettings) .catch(error => { ... });`

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

exitFullscreen()	Запрашивает браузер для выхода из полноэкранного режима.
fullscreen()	Запрашивает браузер отрисовку iframe компонента в полноэкранном режиме.
getCorrelationId()	Получите идентификатор корреляции для текущего сеанса внедрения. `// Get the correlationId for the current embed session report.getCorrelationId() .then(correlationId => { ... });`
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); });`
reload()	Перезагрузит внедрение с помощью существующей конфигурации. Например, для отчетов это эффективно очищает все фильтры и делает первую страницу активной, которая имитирует сброс отчета обратно в загруженное состояние. `report.reload();`
removeComponentTabIndex(number)	Удаляет атрибут tabindex элемента
save()	Сохраняет отчет.
saveAs(ISaveAsParameters)	Отчет SaveAs.
setAccessToken(string)	Задайте accessToken.
setComponentTabIndex(number)	Задает атрибут tabindex элемента
setComponentTitle(string)	Задайте заголовок компонента для специальных возможностей. В случае iframe этот метод изменит заголовок iframe.

Сведения о свойстве

bookmarksManager

bookmarksManager: BookmarksManager

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

BookmarksManager

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

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

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

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>

applyTheme(IReportTheme)

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

report.applyTheme(theme);

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

Параметры

theme: IReportTheme

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

Promise<void>

arePersistentFiltersApplied()

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

report.arePersistentFiltersApplied();

function arePersistentFiltersApplied(): Promise<boolean>

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

Promise<boolean>

clearSelectedVisuals(boolean)

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

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

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

Параметры

clearPopOutState: boolean

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

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

Promise<void>

closeAllOverlays()

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

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

function closeAllOverlays(): Promise<void>

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

Promise<void>

configChanged(boolean)

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

function configChanged(isBootstrap: boolean)

Параметры

isBootstrap: 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");

function deletePage(pageName: string): Promise<void>

Параметры

pageName: string

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

Promise<void>

getActivePage()

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

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

function getActivePage(): Promise<Page>

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

Promise<Page>

getFilters()

Получает фильтры, применяемые на уровне отчета.

// Get filters applied at report level
report.getFilters()
  .then(filters => {
    ...
  });

function getFilters(): Promise<IFilter[]>

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

Promise<IFilter[]>

getId()

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

function getId(): string

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

string

getPageByName(string)

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

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

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

Параметры

pageName: string

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

Promise<Page>

getPages()

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

report.getPages()
 .then(pages => {
     ...
 });

function getPages(): Promise<Page[]>

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

Promise<Page[]>

getTheme()

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

report.getTheme();

function getTheme(): Promise<IReportTheme>

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

Promise<IReportTheme>

getZoom()

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

function getZoom(): Promise<number>

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

Promise<number>

isSaved()

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

report.isSaved()

function isSaved(): Promise<boolean>

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

Promise<boolean>

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

print()

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

function print(): Promise<void>

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

Promise<void>

refresh()

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

report.refresh();

function refresh(): Promise<void>

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

Promise<void>

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

removeFilters()

Удаляет все фильтры на уровне отчета.

report.removeFilters();

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

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

Promise<IHttpPostMessageResponse<void>>

removeOptionsMenuCommand(string, string)

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

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

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

Параметры

commandName: string

optionsMenuTitle: string

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

Promise<IHttpPostMessageResponse<void>>

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>

render(IReportEmbedConfiguration | IReportLoadConfiguration)

Отрисовка предварительно загруженного отчета с помощью api поэтапного внедрения

// Load report
var report = powerbi.load(element, config);

...

// Render report
report.render()

function render(config?: IReportEmbedConfiguration | IReportLoadConfiguration): Promise<void>

Параметры

config: IReportEmbedConfiguration | IReportLoadConfiguration

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

Promise<void>

resetPersistentFilters()

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

report.resetPersistentFilters();

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

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

Promise<IHttpPostMessageResponse<void>>

resetTheme()

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

report.resetTheme();

function resetTheme(): Promise<void>

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

Promise<void>

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

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

savePersistentFilters()

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

report.savePersistentFilters();

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

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

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Задает фильтры на уровне отчета.

const filters: [
   ...
];

report.setFilters(filters)
 .catch(errors => {
   ...
 });

function setFilters(filters: IFilter[]): Promise<IHttpPostMessageResponse<void>>

Параметры

filters: IFilter[]

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

Promise<IHttpPostMessageResponse<void>>

setPage(string)

Задает активную страницу отчета.

report.setPage("page2")
 .catch(error => { ... });

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

Параметры

pageName: string

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

Promise<IHttpPostMessageResponse<void>>

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

displayState: VisualContainerDisplayMode

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

Promise<IHttpPostMessageResponse<void>>

setZoom(number)

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

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

Параметры

zoomLevel: number

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

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

Promise<void>

switchLayout(LayoutType)

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

report.switchLayout(layoutType);

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

Параметры

layoutType: LayoutType

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

Promise<IHttpPostMessageResponse<void>>

switchMode(string | ViewMode)

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

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

Параметры

viewMode: string | ViewMode

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

Promise<void>

updateFilters(FiltersOperations, IFilter[])

Обновите фильтры на уровне отчета в соответствии с операцией: добавьте, замените все, замените целевым объектом или удалите.

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

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

Параметры

operation: FiltersOperations

filters: IFilter[]

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

Promise<IHttpPostMessageResponse<void>>

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

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

exitFullscreen()

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

function exitFullscreen()

наследуется от Embed.exitFullscreen

fullscreen()

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

function fullscreen()

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

getCorrelationId()

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

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

function getCorrelationId(): Promise<string>

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

Promise<string>

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

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>

унаследовано от Embed.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>

наследуется от Embed.on

reload()

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

report.reload();

function reload(): Promise<void>

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

Promise<void>

наследуется от Embed.reload

removeComponentTabIndex(number)

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

function removeComponentTabIndex(_tabIndex?: number)

Параметры

_tabIndex: number

унаследован от Embed.removeComponentTabIndex

save()

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

function save(): Promise<void>

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

Promise<void>

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

saveAs(ISaveAsParameters)

Отчет SaveAs.

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

Параметры

saveAsParameters: ISaveAsParameters

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

Promise<void>

унаследован от Embed.saveAs

setAccessToken(string)

Задайте accessToken.

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

Параметры

accessToken: string

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

Promise<void>

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

setComponentTabIndex(number)

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

function setComponentTabIndex(tabIndex?: number)

Параметры

tabIndex: number

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

setComponentTitle(string)

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

function setComponentTitle(title: string)

Параметры

title: string

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

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

Report class

Свойства

Методы

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

Сведения о свойстве

bookmarksManager

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

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

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

Параметры

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

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

Параметры

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

addPage(string)

Параметры

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

applyTheme(IReportTheme)

Параметры

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

arePersistentFiltersApplied()

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

clearSelectedVisuals(boolean)

Параметры

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

closeAllOverlays()

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

configChanged(boolean)

Параметры

deletePage(string)

Параметры

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

getActivePage()

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

getFilters()

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

getId()

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

getPageByName(string)

Параметры

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

getPages()

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

getTheme()

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

getZoom()

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

isSaved()

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

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

Параметры

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

print()

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

refresh()

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

removeContextMenuCommand(string, string)

Параметры

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

removeFilters()

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

removeOptionsMenuCommand(string, string)

Параметры

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

renamePage(string, string)

Параметры

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

render(IReportEmbedConfiguration | IReportLoadConfiguration)

Параметры

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

resetPersistentFilters()

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

resetTheme()

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

resizeActivePage(PageSizeType, number, number)

Параметры

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

resizeVisual(string, string, number, number)

Параметры