Report class

Referência

Pacote:: powerbi-client

O componente de inserção de Relatório do Power BI

Extends: Embed

Propriedades

Métodos

addContextMenuCommand(string, string, string, MenuLocation, string, string, string)	Comando adicionar extensão de menu de contexto. `report.addContextMenuCommand(commandName, commandTitle, contextMenuTitle, menuLocation, visualName, visualType, groupName) .catch(error => { ... });`
addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)	Comando adicionar extensão de menu de opções. `report.addOptionsMenuCommand(commandName, commandTitle, optionsMenuTitle, menuLocation, visualName, visualType, groupName, commandIcon) .catch(error => { ... });`
addPage(string)	Adicionar uma página vazia ao relatório `// Add a page to the report with "Sales" as the page display name report.addPage("Sales");`
applyTheme(IReportTheme)	Aplicar um tema ao relatório `report.applyTheme(theme);`
arePersistentFiltersApplied()	Retornará se houver filtros, segmentações ou outras alterações de exibição de dados do usuário aplicadas no relatório. Se filtros persistentes forem desabilitados, retornará false. `report.arePersistentFiltersApplied();`
clearSelectedVisuals(boolean)	Limpa os visuais selecionados não exibidos, se o sinalizador for passado, todas as seleções de visuais serão desmarcadas. `report.clearSelectedVisuals() .then(() => { ... });`
closeAllOverlays()	Fecha todos os menus de contexto abertos e dicas de ferramentas. `report.closeAllOverlays() .then(() => { ... });`
configChanged(boolean)	Manipular alterações de configuração.
deletePage(string)	Excluir uma página de um relatório `// 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()	Obtém a página de relatório ativa. `report.getActivePage() .then(activePage => { ... });`
getFilters()	Obtém filtros que são aplicados no nível do relatório. `// Get filters applied at report level report.getFilters() .then(filters => { ... });`
getId()	Obtém a ID do relatório do primeiro local disponível: opções, atributo, URL de inserção.
getPageByName(string)	Obtém uma página de relatório pelo nome. `report.getPageByName(pageName) .then(page => { ... });`
getPages()	Obtém a lista de páginas dentro do relatório. `report.getPages() .then(pages => { ... });`
getTheme()	obter o tema do relatório `report.getTheme();`
getZoom()	Retornar o nível de zoom atual do relatório.
isSaved()	verifica se o relatório foi salvo. `report.isSaved()`
moveVisual(string, string, number, number, number)	Atualizações a posição de um visual em uma página. `report.moveVisual(pageName, visualName, x, y, z) .catch(error => { ... });`
print()	Imprime a página ativa do relatório invocando `window.print()` no componente iframe de inserção.
refresh()	Atualiza as fontes de dados para o relatório. `report.refresh();`
removeContextMenuCommand(string, string)	Remover o comando de extensão de menu de contexto. `report.removeContextMenuCommand(commandName, contextMenuTitle) .catch(error => { ... });`
removeFilters()	Remove todos os filtros no nível do relatório. `report.removeFilters();`
removeOptionsMenuCommand(string, string)	Comando remover extensão de menu de opções. `report.removeOptionsMenuCommand(commandName, optionsMenuTitle) .then({ ... });`
renamePage(string, string)	Renomear uma página de um relatório `// 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)	Renderizar um relatório pré-carregado usando a API de inserção em fases `// Load report var report = powerbi.load(element, config); ... // Render report report.render()`
resetPersistentFilters()	Redefinir filtros, segmentações e outras alterações de exibição de dados do usuário para o estado padrão do relatório `report.resetPersistentFilters();`
resetTheme()	Redefinir e aplicar o tema padrão do relatório `report.resetTheme();`
resizeActivePage(PageSizeType, number, number)	Atualizações o tamanho da página ativa no relatório. `report.resizeActivePage(pageSizeType, width, height) .catch(error => { ... });`
resizeVisual(string, string, number, number)	Redimensionar um visual em uma página. `report.resizeVisual(pageName, visualName, width, height) .catch(error => { ... });`
savePersistentFilters()	Salvar filtros, segmentações de dados e outras alterações de exibição de dados do relatório `report.savePersistentFilters();`
setFilters(IFilter[])	Define filtros no nível do relatório. `const filters: [ ... ]; report.setFilters(filters) .catch(errors => { ... });`
setPage(string)	Define a página ativa do relatório. `report.setPage("page2") .catch(error => { ... });`
setVisualDisplayState(string, string, VisualContainerDisplayMode)	Atualizações o estado de exibição de um visual em uma página. `report.setVisualDisplayState(pageName, visualName, displayState) .catch(error => { ... });`
setZoom(number)	Define o nível de zoom do relatório.
switchLayout(LayoutType)	Atualizações o layout do relatório `report.switchLayout(layoutType);`
switchMode(string \| ViewMode)	Alternar modo de exibição de relatório.
updateFilters(FiltersOperations, IFilter[])	Atualize os filtros no nível do relatório de acordo com a operação: Adicionar, substituir todos, substituir por destino ou remover. `report.updateFilters(FiltersOperations.Add, filters) .catch(errors => { ... });`
updateSettings(ISettings)	Atualizações configurações de visibilidade para o painel de filtro e o painel de navegação da página. `const newSettings = { panes: { filters: { visible: false } } }; report.updateSettings(newSettings) .catch(error => { ... });`

Métodos herdados

exitFullscreen()	Solicita que o navegador saia do modo de tela inteira.
fullscreen()	Solicita que o navegador renderize o iframe do componente no modo de tela inteira.
getCorrelationId()	Obtenha a correlationId para a sessão de inserçã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 inserçã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 para o estado carregado. `report.reload();`
removeComponentTabIndex(number)	Remove o atributo tabindex do elemento
save()	Salva o Relatório.
saveAs(ISaveAsParameters)	SaveAs Report.
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, esse método alterará o título iframe.

Detalhes da propriedade

bookmarksManager

bookmarksManager: BookmarksManager

Valor da propriedade

BookmarksManager

Detalhes do método

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

Comando adicionar extensão de menu de contexto.

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

Parâmetros

commandName: string

commandTitle: string

contextMenuTitle: string

menuLocation: MenuLocation

visualName: string

visualType: string

groupName: string

Retornos

Promise<IHttpPostMessageResponse<void>>

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

Comando adicionar extensão de menu de opções.

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

Parâmetros

commandName: string

commandTitle: string

optionsMenuTitle: string

menuLocation: MenuLocation

visualName: string

visualType: string

groupName: string

commandIcon: string

Retornos

Promise<IHttpPostMessageResponse<void>>

addPage(string)

Adicionar uma página vazia ao relatório

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

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

Parâmetros

displayName: string

Retornos

Promise<Page>

applyTheme(IReportTheme)

Aplicar um tema ao relatório

report.applyTheme(theme);

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

Parâmetros

theme: IReportTheme

Retornos

Promise<void>

arePersistentFiltersApplied()

Retornará se houver filtros, segmentações ou outras alterações de exibição de dados do usuário aplicadas no relatório. Se filtros persistentes forem desabilitados, retornará false.

report.arePersistentFiltersApplied();

function arePersistentFiltersApplied(): Promise<boolean>

Retornos

Promise<boolean>

clearSelectedVisuals(boolean)

Limpa os visuais selecionados não exibidos, se o sinalizador for passado, todas as seleções de visuais serão desmarcadas.

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

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

Parâmetros

clearPopOutState: boolean

Se a seleção de visuais false/indefinido não for desmarcada se um dos visuais estiver no estado de saída (em foco, mostrar como tabela, destaque...)

Retornos

Promise<void>

closeAllOverlays()

Fecha todos os menus de contexto abertos e dicas de ferramentas.

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

function closeAllOverlays(): Promise<void>

Retornos

Promise<void>

configChanged(boolean)

Manipular alterações de configuração.

function configChanged(isBootstrap: boolean)

Parâmetros

isBootstrap: boolean

deletePage(string)

Excluir uma página de um relatório

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

Parâmetros

pageName: string

Retornos

Promise<void>

getActivePage()

Obtém a página de relatório ativa.

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

function getActivePage(): Promise<Page>

Retornos

Promise<Page>

getFilters()

Obtém filtros que são aplicados no nível do relatório.

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

function getFilters(): Promise<IFilter[]>

Retornos

Promise<IFilter[]>

getId()

Obtém a ID do relatório do primeiro local disponível: opções, atributo, URL de inserção.

function getId(): string

Retornos

string

getPageByName(string)

Obtém uma página de relatório pelo nome.

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

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

Parâmetros

pageName: string

Retornos

Promise<Page>

getPages()

Obtém a lista de páginas dentro do relatório.

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

function getPages(): Promise<Page[]>

Retornos

Promise<Page[]>

getTheme()

obter o tema do relatório

report.getTheme();

function getTheme(): Promise<IReportTheme>

Retornos

Promise<IReportTheme>

getZoom()

Retornar o nível de zoom atual do relatório.

function getZoom(): Promise<number>

Retornos

Promise<number>

isSaved()

verifica se o relatório foi salvo.

report.isSaved()

function isSaved(): Promise<boolean>

Retornos

Promise<boolean>

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

Atualizações a posição de um visual em uma página.

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

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

Parâmetros

pageName: string

visualName: string

x: number

y: number

z: number

Retornos

Promise<IHttpPostMessageResponse<void>>

print()

Imprime a página ativa do relatório invocando window.print() no componente iframe de inserção.

function print(): Promise<void>

Retornos

Promise<void>

refresh()

Atualiza as fontes de dados para o relatório.

report.refresh();

function refresh(): Promise<void>

Retornos

Promise<void>

removeContextMenuCommand(string, string)

Remover o comando de extensão de menu de contexto.

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

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

Parâmetros

commandName: string

contextMenuTitle: string

Retornos

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Remove todos os filtros no nível do relatório.

report.removeFilters();

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

Retornos

Promise<IHttpPostMessageResponse<void>>

removeOptionsMenuCommand(string, string)

Comando remover extensão de menu de opções.

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

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

Parâmetros

commandName: string

optionsMenuTitle: string

Retornos

Promise<IHttpPostMessageResponse<void>>

renamePage(string, string)

Renomear uma página de um relatório

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

Parâmetros

pageName: string

displayName: string

Retornos

Promise<void>

render(IReportEmbedConfiguration | IReportLoadConfiguration)

Renderizar um relatório pré-carregado usando a API de inserção em fases

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

...

// Render report
report.render()

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

Parâmetros

config: IReportEmbedConfiguration | IReportLoadConfiguration

Retornos

Promise<void>

resetPersistentFilters()

Redefinir filtros, segmentações e outras alterações de exibição de dados do usuário para o estado padrão do relatório

report.resetPersistentFilters();

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

Retornos

Promise<IHttpPostMessageResponse<void>>

resetTheme()

Redefinir e aplicar o tema padrão do relatório

report.resetTheme();

function resetTheme(): Promise<void>

Retornos

Promise<void>

resizeActivePage(PageSizeType, number, number)

Atualizações o tamanho da página ativa no relatório.

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

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

Parâmetros

pageSizeType: PageSizeType

width: number

height: number

Retornos

Promise<IHttpPostMessageResponse<void>>

resizeVisual(string, string, number, number)

Redimensionar um visual em uma página.

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

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

Parâmetros

pageName: string

visualName: string

width: number

height: number

Retornos

Promise<IHttpPostMessageResponse<void>>

savePersistentFilters()

Salvar filtros, segmentações de dados e outras alterações de exibição de dados do relatório

report.savePersistentFilters();

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

Retornos

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Define filtros no nível do relatório.

const filters: [
   ...
];

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

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

Parâmetros

filters: IFilter[]

Retornos

Promise<IHttpPostMessageResponse<void>>

setPage(string)

Define a página ativa do relatório.

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

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

Parâmetros

pageName: string

Retornos

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(string, string, VisualContainerDisplayMode)

Atualizações o estado de exibição de um visual em uma página.

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

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

Parâmetros

pageName: string

visualName: string

displayState: VisualContainerDisplayMode

Retornos

Promise<IHttpPostMessageResponse<void>>

setZoom(number)

Define o nível de zoom do relatório.

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

Parâmetros

zoomLevel: number

nível de zoom a ser definido

Retornos

Promise<void>

switchLayout(LayoutType)

Atualizações o layout do relatório

report.switchLayout(layoutType);

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

Parâmetros

layoutType: LayoutType

Retornos

Promise<IHttpPostMessageResponse<void>>

switchMode(string | ViewMode)

Alternar modo de exibição de relatório.

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

Parâmetros

viewMode: string | ViewMode

Retornos

Promise<void>

updateFilters(FiltersOperations, IFilter[])

Atualize os filtros no nível do relatório de acordo com a operação: Adicionar, substituir todos, substituir por destino ou remover.

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

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

Parâmetros

operation: FiltersOperations

filters: IFilter[]

Retornos

Promise<IHttpPostMessageResponse<void>>

updateSettings(ISettings)

Atualizações configurações de visibilidade para o painel de filtro e o painel de navegação da página.

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

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

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

Parâmetros

settings: ISettings

Retornos

Promise<IHttpPostMessageResponse<void>>

Detalhes do método herdado

exitFullscreen()

Solicita que o navegador saia do modo de tela inteira.

function exitFullscreen()

Herdado de Embed.exitFullscreen

fullscreen()

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

function fullscreen()

Herdado de Embed.fullscreen

getCorrelationId()

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

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

function getCorrelationId(): Promise<string>

Retornos

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 Inserir.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 Inserir.on

reload()

Recarrega a inserçã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 para o estado carregado.

report.reload();

function reload(): Promise<void>

Retornos

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 o Relatório.

function save(): Promise<void>

Retornos

Promise<void>

Herdado de Embed.save

saveAs(ISaveAsParameters)

SaveAs Report.

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

Parâmetros

saveAsParameters: ISaveAsParameters

Retornos

Promise<void>

Herdado de Embed.saveAs

setAccessToken(string)

Defina accessToken.

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

Parâmetros

accessToken: string

Retornos

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, esse método alterará o título iframe.

function setComponentTitle(title: string)

Parâmetros

title: string

Herdado de Embed.setComponentTitle

Compartilhar via

Report class

Propriedades

Métodos

Métodos herdados

Detalhes da propriedade

bookmarksManager

Valor da propriedade

Detalhes do método

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

Parâmetros

Retornos

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

Parâmetros

Retornos

addPage(string)

Parâmetros

Retornos

applyTheme(IReportTheme)

Parâmetros

Retornos

arePersistentFiltersApplied()

Retornos

clearSelectedVisuals(boolean)

Parâmetros

Retornos

closeAllOverlays()

Retornos

configChanged(boolean)

Parâmetros

deletePage(string)

Parâmetros

Retornos

getActivePage()

Retornos

getFilters()

Retornos

getId()

Retornos

getPageByName(string)

Parâmetros

Retornos

getPages()

Retornos

getTheme()

Retornos

getZoom()

Retornos

isSaved()

Retornos

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

Parâmetros

Retornos

print()

Retornos

refresh()

Retornos

removeContextMenuCommand(string, string)

Parâmetros

Retornos

removeFilters()

Retornos

removeOptionsMenuCommand(string, string)

Parâmetros

Retornos

renamePage(string, string)

Parâmetros

Retornos

render(IReportEmbedConfiguration | IReportLoadConfiguration)

Parâmetros

Retornos

resetPersistentFilters()

Retornos

resetTheme()

Retornos

resizeActivePage(PageSizeType, number, number)

Parâmetros

Retornos

resizeVisual(string, string, number, number)

Parâmetros