Create class

Пакет:

powerbi-client

Компонент создателя отчетов Power BI

Extends

Embed

Конструкторы

Create(Service, HTMLElement, IEmbedConfiguration | IReportCreateConfiguration, boolean, boolean)

Методы

getId()	Возвращает идентификатор набора данных из первого доступного расположения: createConfig или url-адрес внедрения.
isSaved()	проверяет, сохранен ли отчет. report.isSaved()
validate(IEmbedConfigurationBase)	Проверьте конфигурацию создания отчета.

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

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.

Сведения о конструкторе

Create(Service, HTMLElement, IEmbedConfiguration | IReportCreateConfiguration, boolean, boolean)

new Create(service: Service, element: HTMLElement, config: IEmbedConfiguration | IReportCreateConfiguration, phasedRender?: boolean, isBootstrap?: boolean)

Параметры

service

Service

element

HTMLElement

config

IEmbedConfiguration | IReportCreateConfiguration

phasedRender

boolean

isBootstrap

boolean

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

getId()

Возвращает идентификатор набора данных из первого доступного расположения: createConfig или url-адрес внедрения.

function getId(): string

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

string

isSaved()

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

report.isSaved()

function isSaved(): Promise<boolean>

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

Promise<boolean>

validate(IEmbedConfigurationBase)

Проверьте конфигурацию создания отчета.

function validate(config: IEmbedConfigurationBase): IError[]

Параметры

config

IEmbedConfigurationBase

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

IError[]

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

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