Create class

Pacote:

powerbi-client

Um componente criador de relatórios do Power BI

Extends

Embed

Construtores

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

Métodos

getId()	Obtém o ID do conjunto de dados do primeiro local disponível: createConfig ou embed url.
isSaved()	Verifica se o relatório está salvo. report.isSaved()
validate(IEmbedConfigurationBase)	Valide a configuração do relatório de criação.

Métodos Herdados

exitFullscreen()	Solicita que o navegador saia do modo de tela cheia.
fullscreen()	Solicita que o navegador renderize o iframe do componente no modo de tela cheia.
getCorrelationId()	Obtenha o correlationId para a sessão de incorporação atual. // Get the correlationId for the current embed session report.getCorrelationId() .then(correlationId => { ... });
off<T>(string, IEventHandler<T>)	Remove um ou mais manipuladores de eventos da lista de manipuladores. Se uma referência à função de identificador existente for especificada, remova o manipulador específico. Se o manipulador não for especificado, remova todos os manipuladores para o nome do evento especificado. report.off('pageChanged') or const logHandler = function (event) { console.log(event); }; report.off('pageChanged', logHandler);
on<T>(string, IEventHandler<T>)	Adiciona um manipulador de eventos para um evento específico. report.on('pageChanged', (event) => { console.log('PageChanged: ', event.page.name); });
reload()	Recarrega a incorporação usando a configuração existente. Por exemplo, para relatórios, isso limpa efetivamente todos os filtros e torna a primeira página ativa, o que simula a redefinição de um relatório de volta ao estado carregado. report.reload();
removeComponentTabIndex(number)	Remove o atributo tabindex do elemento
save()	Salva relatório.
saveAs(ISaveAsParameters)	Relatório SaveAs.
setAccessToken(string)	Defina accessToken.
setComponentTabIndex(number)	Define o atributo tabindex do elemento
setComponentTitle(string)	Defina o título do componente para acessibilidade. No caso de iframes, este método irá alterar o título do iframe.

Detalhes do Construtor

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

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

Parâmetros

service

Service

element

HTMLElement

config

IEmbedConfiguration | IReportCreateConfiguration

phasedRender

boolean

isBootstrap

boolean

Detalhes de Método

getId()

Obtém o ID do conjunto de dados do primeiro local disponível: createConfig ou embed url.

function getId(): string

Devoluções

string

isSaved()

Verifica se o relatório está salvo.

report.isSaved()

function isSaved(): Promise<boolean>

Devoluções

Promise<boolean>

validate(IEmbedConfigurationBase)

Valide a configuração do relatório de criação.

function validate(config: IEmbedConfigurationBase): IError[]

Parâmetros

config

IEmbedConfigurationBase

Devoluções

IError[]

Detalhes do Método Herdado

exitFullscreen()

Solicita que o navegador saia do modo de tela cheia.

function exitFullscreen()

herdado de Embed.exitFullscreen

fullscreen()

Solicita que o navegador renderize o iframe do componente no modo de tela cheia.

function fullscreen()

herdado de Embed.fullscreen

getCorrelationId()

Obtenha o correlationId para a sessão de incorporação atual.

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

function getCorrelationId(): Promise<string>

Devoluções

Promise<string>

herdado de Embed.getCorrelationId

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

Remove um ou mais manipuladores de eventos da lista de manipuladores. Se uma referência à função de identificador existente for especificada, remova o manipulador específico. Se o manipulador não for especificado, remova todos os manipuladores para o nome do evento especificado.

report.off('pageChanged')

or

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

report.off('pageChanged', logHandler);

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

Parâmetros

eventName

string

handler

IEventHandler<T>

herdado de Embed.off

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

Adiciona um manipulador de eventos para um evento específico.

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

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

Parâmetros

eventName

string

handler

IEventHandler<T>

herdado de Embed.on

reload()

Recarrega a incorporação usando a configuração existente. Por exemplo, para relatórios, isso limpa efetivamente todos os filtros e torna a primeira página ativa, o que simula a redefinição de um relatório de volta ao estado carregado.

report.reload();

function reload(): Promise<void>

Devoluções

Promise<void>

herdado de Embed.reload

removeComponentTabIndex(number)

Remove o atributo tabindex do elemento

function removeComponentTabIndex(_tabIndex?: number)

Parâmetros

_tabIndex

number

herdado de Embed.removeComponentTabIndex

save()

Salva relatório.

function save(): Promise<void>

Devoluções

Promise<void>

herdado de Embed.save

saveAs(ISaveAsParameters)

Relatório SaveAs.

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

Parâmetros

saveAsParameters

ISaveAsParameters

Devoluções

Promise<void>

herdado de Embed.saveAs

setAccessToken(string)

Defina accessToken.

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

Parâmetros

accessToken

string

Devoluções

Promise<void>

herdado de Embed.setAccessToken

setComponentTabIndex(number)

Define o atributo tabindex do elemento

function setComponentTabIndex(tabIndex?: number)

Parâmetros

tabIndex

number

herdado de Embed.setComponentTabIndex

setComponentTitle(string)

Defina o título do componente para acessibilidade. No caso de iframes, este método irá alterar o título do iframe.

function setComponentTitle(title: string)

Parâmetros

title

string

herdado de Embed.setComponentTitle