Report class

bookmarksManager: BookmarksManager

Valor da propriedade

Adicionar comando de 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

Retornos

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

Retornos

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

Retornos

Aplicar um tema ao relatório

report.applyTheme(theme);

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

Parâmetros

Retornos

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

report.arePersistentFiltersApplied();

function arePersistentFiltersApplied(): Promise<boolean>

Retornos

As limpezas selecionadas não serão exibidas nos visuais, 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

Retornos

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

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

function closeAllOverlays(): Promise<void>

Retornos

Manipular alterações de configuração.

function configChanged(isBootstrap: boolean)

Parâmetros

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

Retornos

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

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

function getActivePage(): Promise<Page>

Retornos

Obtém filtros aplicados no nível do relatório.

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

function getFilters(): Promise<IFilter[]>

Retornos

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

function getId(): string

Retornos

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

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

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

Parâmetros

Retornos

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

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

function getPages(): Promise<Page[]>

Retornos

obter o tema do relatório

report.getTheme();

function getTheme(): Promise<IReportTheme>

Retornos

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

function getZoom(): Promise<number>

Retornos

verifica se o relatório foi salvo.

report.isSaved()

function isSaved(): Promise<boolean>

Retornos

Atualiza 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

Retornos

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

function print(): Promise<void>

Retornos

Atualiza as fontes de dados do relatório.

report.refresh();

function refresh(): Promise<void>

Retornos

Remova 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

Retornos

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

report.removeFilters();

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

Retornos

Remover o comando de extensão do menu opções.

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

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

Parâmetros

Retornos

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

Retornos

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

Retornos

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

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

report.resetTheme();

function resetTheme(): Promise<void>

Retornos

Atualiza 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

Retornos

Redimensione 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

Retornos

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

Define filtros no nível do relatório.

const filters: [
   ...
];

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

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

Parâmetros

Retornos

Define a página ativa do relatório.

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

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

Parâmetros

Retornos

Atualiza 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

Retornos

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

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

Parâmetros

Retornos

Atualiza o layout do relatório

report.switchLayout(layoutType);

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

Parâmetros

Retornos

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

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

Parâmetros

Retornos

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

Retornos

Atualiza as configurações de visibilidade do painel de filtro e do 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

Retornos

Solicita que o navegador saia do modo de tela inteira.

function exitFullscreen()

Herdado de Embed.exitFullscreen

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

function fullscreen()

herdado de Inserção.fullscreen

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

Herdado de Embed.getCorrelationId

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

Herdado de Inserção.off

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

Herdado de Inserção.on

Recarrega o 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 ao estado carregado.

report.reload();

function reload(): Promise<void>

Retornos

Herdado de Embed.reload

Remove o atributo tabindex do elemento

function removeComponentTabIndex(_tabIndex?: number)

Parâmetros

herdado de Embed.removeComponentTabIndex

Salva o relatório.

function save(): Promise<void>

Retornos

Herdado de Embed.save

Relatório SaveAs.

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

Parâmetros

Retornos

Herdado de Embed.saveAs

Defina accessToken.

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

Parâmetros

Retornos

Herdado de Embed.setAccessToken

Define o atributo tabindex do elemento

function setComponentTabIndex(tabIndex?: number)

Parâmetros

Herdado de Embed.setComponentTabIndex

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

Herdado de Embed.setComponentTitle