Compartilhar via


Visual class

O componente de inserção do Visual do Power BI

Extends

Propriedades herdadas

bookmarksManager

Métodos

getFilters(FiltersLevel)

Obtém filtros aplicados ao nível do filtro. O nível de filtro padrão é o nível visual.

visual.getFilters(filtersLevel)
  .then(filters => {
    ...
  });
getPages()

Obtém a lista de páginas no relatório – sem suporte no visual

getVisualDescriptor()

Obtém o objeto descritor visual inserido que contém o nome do visual, o tipo etc.

visual.getVisualDescriptor()
  .then(visualDetails => { ... });
removeFilters(FiltersLevel)

Remove todos os filtros do nível de filtro atual. O nível de filtro padrão é o nível visual.

visual.removeFilters(filtersLevel);
setFilters(IFilter[], FiltersLevel)

Define filtros no nível do filtro. O nível de filtro padrão é o nível visual.

const filters: [
   ...
];

visual.setFilters(filters, filtersLevel)
 .catch(errors => {
   ...
 });
setPage(string)

Define a página ativa do relatório – sem suporte no visual

updateFilters(FiltersOperations, IFilter[], FiltersLevel)

Atualiza filtros no nível do filtro. O nível de filtro padrão é o nível visual.

const filters: [
   ...
];

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

Métodos herdados

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

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

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();
clearSelectedVisuals(boolean)

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(() => {
     ...
 });
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");
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.

getActivePage()

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

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

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

// Get the correlationId for the current embed session
report.getCorrelationId()
  .then(correlationId => {
    ...
  });
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 => {
     ...
 });
getTheme()

obter o tema do relatório

report.getTheme();
getZoom()

Retorne 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 a posição de um visual em uma página.

report.moveVisual(pageName, visualName, x, y, z)
  .catch(error => { ... });
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 do 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);
});
print()

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

refresh()

Atualiza as fontes de dados do relatório.

report.refresh();
reload()

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();
removeComponentTabIndex(number)

Remove o atributo tabindex do elemento

removeContextMenuCommand(string, string)

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

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

Remover o comando de extensão do menu 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");
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 o tamanho da página ativa no relatório.

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

Redimensione um visual em uma página.

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

Salva o relatório.

saveAs(ISaveAsParameters)

Relatório SaveAs.

savePersistentFilters()

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

report.savePersistentFilters();
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.

setVisualDisplayState(string, string, VisualContainerDisplayMode)

Atualiza 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 o layout do relatório

report.switchLayout(layoutType);
switchMode(string | ViewMode)

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

updateSettings(ISettings)

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 => { ... });

Detalhes das propriedades herdadas

bookmarksManager

bookmarksManager: BookmarksManager

Valor da propriedade

Herdado deReport.bookmarksManager

Detalhes do método

getFilters(FiltersLevel)

Obtém filtros aplicados ao nível do filtro. O nível de filtro padrão é o nível visual.

visual.getFilters(filtersLevel)
  .then(filters => {
    ...
  });
function getFilters(filtersLevel?: FiltersLevel): Promise<IFilter[]>

Parâmetros

filtersLevel
FiltersLevel

Retornos

Promise<IFilter[]>

getPages()

Obtém a lista de páginas no relatório – sem suporte no visual

function getPages(): Promise<Page[]>

Retornos

Promise<Page[]>

getVisualDescriptor()

Obtém o objeto descritor visual inserido que contém o nome do visual, o tipo etc.

visual.getVisualDescriptor()
  .then(visualDetails => { ... });
function getVisualDescriptor(): Promise<VisualDescriptor>

Retornos

Promise<VisualDescriptor>

removeFilters(FiltersLevel)

Remove todos os filtros do nível de filtro atual. O nível de filtro padrão é o nível visual.

visual.removeFilters(filtersLevel);
function removeFilters(filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>

Parâmetros

filtersLevel
FiltersLevel

Retornos

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[], FiltersLevel)

Define filtros no nível do filtro. O nível de filtro padrão é o nível visual.

const filters: [
   ...
];

visual.setFilters(filters, filtersLevel)
 .catch(errors => {
   ...
 });
function setFilters(filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>

Parâmetros

filters

IFilter[]

filtersLevel
FiltersLevel

Retornos

Promise<IHttpPostMessageResponse<void>>

setPage(string)

Define a página ativa do relatório – sem suporte no visual

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

Parâmetros

_pageName

string

Retornos

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[], FiltersLevel)

Atualiza filtros no nível do filtro. O nível de filtro padrão é o nível visual.

const filters: [
   ...
];

visual.updateFilters(FiltersOperations.Add, filters, filtersLevel)
 .catch(errors => {
   ...
 });
function updateFilters(operation: FiltersOperations, filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>

Parâmetros

operation
FiltersOperations
filters

IFilter[]

filtersLevel
FiltersLevel

Retornos

Promise<IHttpPostMessageResponse<void>>

Detalhes do método herdado

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

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

commandName

string

commandTitle

string

contextMenuTitle

string

menuLocation
MenuLocation
visualName

string

visualType

string

groupName

string

Retornos

Promise<IHttpPostMessageResponse<void>>

Herdado deReport.addContextMenuCommand

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

Herdado deReport.addOptionsMenuCommand

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>

Herdado deReport.addPage

applyTheme(IReportTheme)

Aplicar um tema ao relatório

report.applyTheme(theme);
function applyTheme(theme: IReportTheme): Promise<void>

Parâmetros

theme
IReportTheme

Retornos

Promise<void>

Herdado deReport.applyTheme

arePersistentFiltersApplied()

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

Promise<boolean>

Herdado deReport.arePersistentFiltersApplied

clearSelectedVisuals(boolean)

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

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>

Herdado deReport.clearSelectedVisuals

closeAllOverlays()

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

report.closeAllOverlays()
 .then(() => {
     ...
 });
function closeAllOverlays(): Promise<void>

Retornos

Promise<void>

Herdado do Report.closeAllOverlays do

configChanged(boolean)

Manipular alterações de configuração.

function configChanged(isBootstrap: boolean)

Parâmetros

isBootstrap

boolean

herdado dereport.configChanged

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>

herdado deReport.deletePage

exitFullscreen()

Solicita que o navegador saia do modo de tela inteira.

function exitFullscreen()

herdado do Report.exitFullscreen do

fullscreen()

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

function fullscreen()

herdado do report.fullscreen do

getActivePage()

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

report.getActivePage()
 .then(activePage => {
     ...
 });
function getActivePage(): Promise<Page>

Retornos

Promise<Page>

Herdado deReport.getActivePage

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 deReport.getCorrelationId

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

Herdado deReport.getId

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>

herdado deReport.getPageByName

getTheme()

obter o tema do relatório

report.getTheme();
function getTheme(): Promise<IReportTheme>

Retornos

Promise<IReportTheme>

herdado deReport.getTheme

getZoom()

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

function getZoom(): Promise<number>

Retornos

Promise<number>

herdado doReport.getZoom

isSaved()

verifica se o relatório foi salvo.

report.isSaved()
function isSaved(): Promise<boolean>

Retornos

Promise<boolean>

Herdado deReport.isSaved

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

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

pageName

string

visualName

string

x

number

y

number

z

number

Retornos

Promise<IHttpPostMessageResponse<void>>

herdado do Report.moveVisual do

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

eventName

string

handler

IEventHandler<T>

herdado doReport.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 do relatório.on

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>

Herdado deReport.print

refresh()

Atualiza as fontes de dados do relatório.

report.refresh();
function refresh(): Promise<void>

Retornos

Promise<void>

herdado dereport.refresh

reload()

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

Promise<void>

Herdado deReport.reload

removeComponentTabIndex(number)

Remove o atributo tabindex do elemento

function removeComponentTabIndex(_tabIndex?: number)

Parâmetros

_tabIndex

number

Herdado deReport.removeComponentTabIndex

removeContextMenuCommand(string, string)

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

commandName

string

contextMenuTitle

string

Retornos

Promise<IHttpPostMessageResponse<void>>

Herdado deReport.removeContextMenuCommand

removeOptionsMenuCommand(string, string)

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

commandName

string

optionsMenuTitle

string

Retornos

Promise<IHttpPostMessageResponse<void>>

Herdado deReport.removeOptionsMenuCommand

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>

Herdado deReport.renamePage

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

Herdado deReport.resetPersistentFilters

resetTheme()

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

report.resetTheme();
function resetTheme(): Promise<void>

Retornos

Promise<void>

Herdado deReport.resetTheme

resizeActivePage(PageSizeType, number, number)

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

pageSizeType
PageSizeType
width

number

height

number

Retornos

Promise<IHttpPostMessageResponse<void>>

Herdado deReport.resizeActivePage

resizeVisual(string, string, number, number)

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

pageName

string

visualName

string

width

number

height

number

Retornos

Promise<IHttpPostMessageResponse<void>>

herdado do Report.resizeVisual

save()

Salva o relatório.

function save(): Promise<void>

Retornos

Promise<void>

herdado deReport.save

saveAs(ISaveAsParameters)

Relatório SaveAs.

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

Parâmetros

saveAsParameters
ISaveAsParameters

Retornos

Promise<void>

herdado deReport.saveAs

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

Herdado deReport.savePersistentFilters

setAccessToken(string)

Defina accessToken.

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

Parâmetros

accessToken

string

Retornos

Promise<void>

Herdado deReport.setAccessToken

setComponentTabIndex(number)

Define o atributo tabindex do elemento

function setComponentTabIndex(tabIndex?: number)

Parâmetros

tabIndex

number

Herdado deReport.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 deReport.setComponentTitle

setVisualDisplayState(string, string, VisualContainerDisplayMode)

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

pageName

string

visualName

string

Retornos

Promise<IHttpPostMessageResponse<void>>

Herdado deReport.setVisualDisplayState

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>

Herdado deReport.setZoom

switchLayout(LayoutType)

Atualiza o layout do relatório

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

Parâmetros

layoutType
LayoutType

Retornos

Promise<IHttpPostMessageResponse<void>>

herdado doReport.switchLayout

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>

Herdado deReport.switchMode

updateSettings(ISettings)

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

settings
ISettings

Retornos

Promise<IHttpPostMessageResponse<void>>

herdado dereport.updateSettings