Visual class
O componente de incorporação Visual do Power BI
- Extends
Propriedades Herdadas
| bookmarks |
Métodos
| get |
Obtém filtros que são aplicados ao nível do filtro. O nível de filtro padrão é o nível visual.
|
| get |
Obtém a lista de páginas dentro do relatório - não suportado no visual |
| get |
Obtém o objeto descritor visual incorporado que contém o nome visual, tipo, etc.
|
| remove |
Remove todos os filtros do nível de filtro atual. O nível de filtro padrão é o nível visual.
|
| set |
Define filtros no nível do filtro. O nível de filtro padrão é o nível visual.
|
| set |
Define a página ativa do relatório - não suportada no visual |
| update |
Atualiza os filtros no nível do filtro. O nível de filtro padrão é o nível visual.
|
Métodos Herdados
| add |
Adicionar comando de extensão de menu de contexto.
|
| add |
Adicionar comando de extensão de menu de opções.
|
| add |
Adicionar uma página vazia ao relatório
|
| apply |
Aplicar um tema ao relatório
|
| are |
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.
|
| clear |
Limpa os visuais selecionados e não apareceu, se o sinalizador for passado, todas as seleções visuais serão limpas.
|
| close |
Fecha todos os menus de contexto abertos e dicas de ferramentas.
|
| config |
Manipule as alterações de configuração. |
| delete |
Excluir uma página de um relatório
|
| exit |
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. |
| get |
Obtém a página de relatório ativa.
|
| get |
Obtenha o correlationId para a sessão de incorporação atual.
|
| get |
Obtém a ID do relatório do primeiro local disponível: opções, atributo, url de incorporação. |
| get |
Obtém uma página de relatório com seu nome.
|
| get |
Conheça o tema do relatório
|
| get |
Retornar o nível de zoom atual do relatório. |
| is |
Verifica se o relatório está salvo.
|
| move |
Atualiza a posição de um visual em uma página.
|
| off<T>(string, IEvent |
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.
|
| on<T>(string, IEvent |
Adiciona um manipulador de eventos para um evento específico.
|
| print() | Imprime a página ativa do relatório invocando |
| refresh() | Atualiza as fontes de dados para o relatório.
|
| 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.
|
| remove |
Remove o atributo tabindex do elemento |
| remove |
Remova o comando de extensão do menu de contexto.
|
| remove |
Remova o comando de extensão de menu de opções.
|
| rename |
Renomear uma página de um relatório
|
| reset |
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
|
| reset |
Redefinir e aplicar o tema padrão do relatório
|
| resize |
Atualiza o tamanho da página ativa no relatório.
|
| resize |
Redimensionar um visual em uma página.
|
| save() | Salva relatório. |
| save |
Relatório SaveAs. |
| save |
Salvar filtros, segmentações de dados e outras alterações de exibição de dados do relatório do usuário
|
| set |
Defina accessToken. |
| set |
Define o atributo tabindex do elemento |
| set |
Defina o título do componente para acessibilidade. No caso de iframes, este método irá alterar o título do iframe. |
| set |
Atualiza o estado de exibição de um visual em uma página.
|
| set |
Define o nível de zoom do relatório. |
| switch |
Atualiza o layout do relatório
|
| switch |
Alterne o modo de exibição Relatório. |
| update |
Atualiza as configurações de visibilidade do painel de filtros e do painel de navegação da página.
|
Detalhes da Propriedade Herdada
bookmarksManager
bookmarksManager: BookmarksManager
Valor de Propriedade
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>>
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>>
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>
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>
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>
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)
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()
fullscreen()
getActivePage()
Obtém a página de relatório ativa.
report.getActivePage()
.then(activePage => {
...
});
function getActivePage(): Promise<Page>
Devoluções
Promise<Page>
getCorrelationId()
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>
getTheme()
Conheça o tema do relatório
report.getTheme();
function getTheme(): Promise<IReportTheme>
Devoluções
Promise<IReportTheme>
getZoom()
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>>
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)
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>>
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>>
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>
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>>
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>>
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()
saveAs(ISaveAsParameters)
Relatório SaveAs.
function saveAs(saveAsParameters: ISaveAsParameters): Promise<void>
Parâmetros
- saveAsParameters
- ISaveAsParameters
Devoluções
Promise<void>
herdado deReport.saveAs
savePersistentFilters()
setAccessToken(string)
setComponentTabIndex(number)
setComponentTitle(string)
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
- displayState
- VisualContainerDisplayMode
Devoluções
Promise<IHttpPostMessageResponse<void>>
setZoom(number)
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>>
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>
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>>