Partilhar via


Visual class

O componente de incorporação Visual do Power BI

Extends

Propriedades Herdadas

bookmarksManager

Métodos

getFilters(FiltersLevel)

Obtém filtros que são 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 dentro do relatório - não suportado no visual

getVisualDescriptor()

Obtém o objeto descritor visual incorporado que contém o nome visual, 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 - não suportada no visual

updateFilters(FiltersOperations, IFilter[], FiltersLevel)

Atualiza os 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)

Adicionar comando de 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 do usuário aplicadas no relatório. Se os filtros persistentes estiverem desativados, retornará false.

report.arePersistentFiltersApplied();
clearSelectedVisuals(boolean)

Limpa os visuais selecionados e não apareceu, se o sinalizador for passado, todas as seleções visuais serão limpas.

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

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

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

Manipule as 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 cheia.

fullscreen()

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

getActivePage()

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

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

Obtenha o correlationId para a sessão de incorporaçã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 incorporação.

getPageByName(string)

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

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

Conheça o tema do relatório

report.getTheme();
getZoom()

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

isSaved()

Verifica se o relatório está 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 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);
});
print()

Imprime a página ativa do relatório invocando window.print() no componente iframe incorporado.

refresh()

Atualiza as fontes de dados para o relatório.

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

removeContextMenuCommand(string, string)

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

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

Remova o comando de 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");
resetPersistentFilters()

Redefinir filtros, segmentações de dados 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)

Redimensionar um visual em uma página.

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

Salva 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 do usuá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, este método irá alterar o título do 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)

Alterne o modo de exibição Relatório.

updateSettings(ISettings)

Atualiza as configurações de visibilidade do painel de filtros e do painel de navegação da página.

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

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

Detalhes da Propriedade Herdada

bookmarksManager

bookmarksManager: BookmarksManager

Valor de Propriedade

herdado de Report.bookmarksManager

Detalhes de Método

getFilters(FiltersLevel)

Obtém filtros que são 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

Devoluções

Promise<IFilter[]>

getPages()

Obtém a lista de páginas dentro do relatório - não suportado no visual

function getPages(): Promise<Page[]>

Devoluções

Promise<Page[]>

getVisualDescriptor()

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

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

Devoluções

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

Devoluções

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

Devoluções

Promise<IHttpPostMessageResponse<void>>

setPage(string)

Define a página ativa do relatório - não suportada no visual

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

Parâmetros

_pageName

string

Devoluções

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[], FiltersLevel)

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

Devoluções

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

Devoluções

Promise<IHttpPostMessageResponse<void>>

herdado de Report.addContextMenuCommand

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

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

Devoluções

Promise<IHttpPostMessageResponse<void>>

herdado de Report.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

Devoluções

Promise<Page>

herdado de Report.addPage

applyTheme(IReportTheme)

Aplicar um tema ao relatório

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

Parâmetros

theme
IReportTheme

Devoluções

Promise<void>

herdado deReport.applyTheme

arePersistentFiltersApplied()

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

report.arePersistentFiltersApplied();
function arePersistentFiltersApplied(): Promise<boolean>

Devoluções

Promise<boolean>

herdado de Report.arePersistentFiltersApplied

clearSelectedVisuals(boolean)

Limpa os visuais selecionados e não apareceu, se o sinalizador for passado, todas as seleções visuais serão limpas.

report.clearSelectedVisuals()
 .then(() => {
     ...
 });
function clearSelectedVisuals(clearPopOutState?: boolean): Promise<void>

Parâmetros

clearPopOutState

boolean

Se a seleção de visuais falsos / indefinidos não será limpa se um dos visuais estiver no estado de pop-out (em foco, mostrar como tabela, holofote...)

Devoluções

Promise<void>

herdado de Report.clearSelectedVisuals

closeAllOverlays()

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

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

Devoluções

Promise<void>

herdado deReport.closeAllOverlays

configChanged(boolean)

Manipule as alterações de configuração.

function configChanged(isBootstrap: boolean)

Parâmetros

isBootstrap

boolean

herdado de Report.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

Devoluções

Promise<void>

herdado deReport.deletePage

exitFullscreen()

Solicita que o navegador saia do modo de tela cheia.

function exitFullscreen()

herdado de Report.exitFullscreen

fullscreen()

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

function fullscreen()

herdado de Report.fullscreen

getActivePage()

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

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

Devoluções

Promise<Page>

herdado de Report.getActivePage

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

getId()

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

function getId(): string

Devoluções

string

herdado de Report.getId

getPageByName(string)

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

report.getPageByName(pageName)
 .then(page => {
     ...
 });
function getPageByName(pageName: string): Promise<Page>

Parâmetros

pageName

string

Devoluções

Promise<Page>

herdado de Report.getPageByName

getTheme()

Conheça o tema do relatório

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

Devoluções

Promise<IReportTheme>

herdado de Report.getTheme

getZoom()

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

function getZoom(): Promise<number>

Devoluções

Promise<number>

herdado de Report.getZoom

isSaved()

Verifica se o relatório está salvo.

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

Devoluções

Promise<boolean>

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

Devoluções

Promise<IHttpPostMessageResponse<void>>

herdado de Report.moveVisual

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

print()

Imprime a página ativa do relatório invocando window.print() no componente iframe incorporado.

function print(): Promise<void>

Devoluções

Promise<void>

herdado deReport.print

refresh()

Atualiza as fontes de dados para o relatório.

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

Devoluções

Promise<void>

herdado deReport.refresh

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 doReport.reload

removeComponentTabIndex(number)

Remove o atributo tabindex do elemento

function removeComponentTabIndex(_tabIndex?: number)

Parâmetros

_tabIndex

number

herdado de Report.removeComponentTabIndex

removeContextMenuCommand(string, string)

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

report.removeContextMenuCommand(commandName, contextMenuTitle)
 .catch(error => {
     ...
 });
function removeContextMenuCommand(commandName: string, contextMenuTitle: string): Promise<IHttpPostMessageResponse<void>>

Parâmetros

commandName

string

contextMenuTitle

string

Devoluções

Promise<IHttpPostMessageResponse<void>>

herdado de Report.removeContextMenuCommand

removeOptionsMenuCommand(string, string)

Remova o comando de 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

Devoluções

Promise<IHttpPostMessageResponse<void>>

herdado de Report.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

Devoluções

Promise<void>

herdado de Report.renamePage

resetPersistentFilters()

Redefinir filtros, segmentações de dados 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>>

Devoluções

Promise<IHttpPostMessageResponse<void>>

herdado de Report.resetPersistentFilters

resetTheme()

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

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

Devoluções

Promise<void>

herdado de Report.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

Devoluções

Promise<IHttpPostMessageResponse<void>>

herdado de Report.resizeActivePage

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

Devoluções

Promise<IHttpPostMessageResponse<void>>

herdado deReport.resizeVisual

save()

Salva relatório.

function save(): Promise<void>

Devoluções

Promise<void>

herdado deReport.save

saveAs(ISaveAsParameters)

Relatório SaveAs.

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

Parâmetros

saveAsParameters
ISaveAsParameters

Devoluções

Promise<void>

herdado deReport.saveAs

savePersistentFilters()

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

report.savePersistentFilters();
function savePersistentFilters(): Promise<IHttpPostMessageResponse<void>>

Devoluções

Promise<IHttpPostMessageResponse<void>>

herdado de Report.savePersistentFilters

setAccessToken(string)

Defina accessToken.

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

Parâmetros

accessToken

string

Devoluções

Promise<void>

herdado de Report.setAccessToken

setComponentTabIndex(number)

Define o atributo tabindex do elemento

function setComponentTabIndex(tabIndex?: number)

Parâmetros

tabIndex

number

herdado de Report.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 Report.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

Devoluções

Promise<IHttpPostMessageResponse<void>>

herdado de Report.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 definir

Devoluções

Promise<void>

herdado de Report.setZoom

switchLayout(LayoutType)

Atualiza o layout do relatório

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

Parâmetros

layoutType
LayoutType

Devoluções

Promise<IHttpPostMessageResponse<void>>

herdado de Report.switchLayout

switchMode(string | ViewMode)

Alterne o modo de exibição Relatório.

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

Parâmetros

viewMode

string | ViewMode

Devoluções

Promise<void>

herdado de Report.switchMode

updateSettings(ISettings)

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

Devoluções

Promise<IHttpPostMessageResponse<void>>

herdado de Report.updateSettings