Ocultar ou mostrar cabeçalhos visuais
Os relatórios do Power BI que você inserir em aplicativos contêm visuais, como gráficos, mapas de calor e medidores. Esses visuais têm cabeçalhos que disponibilizam ações aos usuários. Ao usar o Power BI, você pode ocultar ou mostrar o cabeçalho de cada visual em um relatório. Cada visual tem um cartão na seção formatação
Exemplos de ações em cabeçalhos visuais incluem:
- Abrindo o visual no modo de foco.
- Furando ou subindo.
- Exibindo quais filtros e segmentações de dados estão atualmente aplicados ao visual.
- Abrindo o menu de opções do visual.
Às vezes, é útil ocultar essas ações. Por exemplo, quando dois visuais se sobrepõem, talvez você não queira exibir os cabeçalhos de ambos os visuais.
Essa API fornece uma maneira de ocultar ou mostrar cabeçalhos de todos os visuais em um relatório ou apenas os específicos. Você pode configurar a visibilidade na carga do relatório ou chamar o método updateSettings relatório para alterar a visibilidade após o carregamento de um relatório, consulte Atualizar configurações de relatório no runtime.
Você pode usar a API em muitos cenários, incluindo os seguintes casos de uso:
- Oculta apenas alguns dos cabeçalhos visuais em um relatório.
- Use a lógica de negócios em um aplicativo, como um clique de botão, para ocultar ou mostrar um cabeçalho após o carregamento de um relatório.
Como ocultar ou mostrar cabeçalhos visuais
Para ocultar ou mostrar cabeçalhos visuais na API, configure determinados parâmetros nas configurações de um relatório. Consulte Definir configurações de relatório para obter informações gerais sobre como configurar opções em relatórios inseridos.
Configurações de cabeçalho visual
Com cabeçalhos visuais, a visibilidade é atualmente a única configuração que você pode configurar. Para ocultar ou exibir cabeçalhos, você fornece uma lista de objetos de configuração de cabeçalho visual. Cada um contém um objeto de configurações e também pode incluir um seletor.
Seletores identificar os visuais aos quais você está aplicando as configurações. Saiba mais sobre seletores noseletores de
O tipo do objeto de configuração que você fornece à API é IVisualSettings. Posteriormente neste artigo, você encontrará exemplos que mostram como usar essa interface em seu código. modelos do Power BI lista todas as definições de interface que os exemplos usam.
Observe os seguintes pontos:
- O seletor é opcional nessas configurações. Quando você não lista nenhum seletor, a API aplica suas configurações a todos os visuais do relatório.
- Ao usar seletores, você pode especificar visuais por nome ou por tipo. Para obter os nomes e tipos dos visuais em uma determinada página, use o método getVisuals
página.
Regras de precedência
A API aplica as configurações na seguinte ordem:
- Configurações salvas no relatório.
- Configurações que você define no objeto de configuração de inserção, que a API aplica na carga.
- Configurações que você fornece à API de
updateSettings.
Se mais de uma configuração puder ser aplicada a um visual, a API usará a última configuração que se aplica. O Ocultar todos, exceto um cabeçalho visual exemplo na próxima seção ilustra esse ponto.
Exemplos
Esses exemplos mostram diferentes maneiras de usar a API para ocultar ou mostrar cabeçalhos visuais.
Ocultar todos os cabeçalhos visuais
Esse cenário simples fornece aos clientes uma exibição de relatório limpa ocultando todos os cabeçalhos visuais em um relatório:
let embedConfig = {
...
settings: {
...
visualSettings: {
visualHeaders: [
{
settings: {
visible: false
}
/* No selector is listed. The API hides the headers of all the visuals in the report. */
}
]
}
}
};
...
let report = powerbi.embed(embedContainer, embedConfig);
Ocultar o cabeçalho de um visual específico
Este exemplo usa um seletor para aplicar uma configuração de visibilidade a um único visual. Esse cenário aparece quando você deseja ocultar a funcionalidade que não faz sentido para um visual. Use esse código nesse caso:
let embedConfig = {
...
settings: {
...
visualSettings: {
visualHeaders: [
{
settings: {
visible: false
},
selector: {
$schema: "http://powerbi.com/product/schema#visualSelector",
visualName: <The name of the visual> // You can retrieve the name by using getVisuals.
}
}
]
}
}
};
...
let report = powerbi.embed(embedContainer, embedConfig);
Ocultar todos, exceto um cabeçalho visual
Use este código para ocultar todos os cabeçalhos visuais em um relatório, exceto o cabeçalho de um visual específico:
let embedConfig = {
...
settings: {
...
visualSettings: {
visualHeaders: [
{
settings: {
visible: false
}
/* No selector is listed. The API hides the headers of all the visuals in the report. */
},
{
settings: {
visible: true
},
selector: {
$schema: "http://powerbi.com/product/schema#visualSelector",
visualName: <The name of the visual> // You can retrieve the name by using getVisuals.
}
}
]
}
}
};
...
let report = powerbi.embed(embedContainer, embedConfig);
Se você quiser tornar mais de um cabeçalho visível, poderá estender esse código. Configure instâncias adicionais de IVisualHeader com o parâmetro visible em settings definido como true. Para cada visual que deve ter um cabeçalho visível, adicione uma IVisualHeader instância à lista.
Considerações e limitações
- Você só poderá controlar a visibilidade dos cabeçalhos visuais se o relatório inserido estiver no modo de exibição.
- Você só pode ocultar ou mostrar o cabeçalho inteiro de um visual. Você não pode configurar a visibilidade de itens específicos no menu de cabeçalho.
- Quando você usa um seletor para especificar o nome ou o tipo de um visual, use a página método getVisuals para obter o nome do visual, que é um identificador exclusivo. Não configure o seletor com o título do visual.
- Se um usuário salvar um relatório que você insira com a API, as configurações visuais definidas serão salvas no relatório. Você pode evitar essa situação configurando o relatório com um nível de permissão de
Viewem vez deEditouSave.