Usar parâmetros nos painéis do Azure Data Explorer

  • Artigo

Os parâmetros são usados como blocos de construção para filtros nos painéis de Data Explorer do Azure. Eles são gerenciados no escopo do painel e podem ser adicionados a consultas para filtrar os dados apresentados pelo visual subjacente. Uma consulta pode usar um ou mais parâmetros.

Este documento descreve a criação e o uso de parâmetros e filtros vinculados em painéis. Os parâmetros podem ser usados para filtrar dashboard visuais selecionando valores de parâmetro na barra de filtros ou usando filtros cruzados.

Os exemplos de consulta usados neste artigo são baseados na StormEvents tabela na galeria de exemplos.

Observação

O gerenciamento de parâmetros está disponível no modo de Edição para editores de dashboard.

Pré-requisitos

Exibir lista de parâmetros

Para exibir a lista de todos os parâmetros dashboard, selecione o botão Parâmetros na parte superior do dashboard.

Captura de tela do botão de parâmetros na parte superior do dashboard.

Criar um parâmetro

Para criar um parâmetro:

  1. Alterne de Exibição para Modo de Edição .

    Captura de tela do botão de edição na parte superior do dashboard.

  2. Selecione o botão Parâmetros na parte superior do dashboard.

    Captura de tela do botão de parâmetros na parte superior do dashboard.

  3. Selecione o botão + Novo parâmetro na parte superior do painel direito.

  4. Preencha as propriedades relevantes para seu parâmetro.

Propriedades com suporte

No painel Adicionar parâmetro , configure as seguintes propriedades:

Campo Descrição
Rótulo Nome do parâmetro mostrado no painel ou no cartão de edição.
Tipo de parâmetro Um dos seguintes parâmetros:
  • Seleção única: Somente um valor pode ser selecionado no filtro como entrada para o parâmetro.
  • Várias seleções: Um ou mais valores podem ser selecionados no filtro como entrada(s) para o parâmetro.
  • Intervalo de tempo: permite a criação de parâmetros adicionais para filtrar as consultas e os painéis com base no tempo. Por padrão, cada painel tem um seletor de intervalo de tempo.
  • Texto livre: não tem nenhum valor preenchido no filtro. O usuário pode digitar um valor ou copiar/colar um valor no campo de texto. O filtro mantém os valores usados recentemente.
Nome da variável Nome do parâmetro a ser usado na consulta. Dica: prefixar nomes de variáveis com um caractere distinto, como um caractere de sublinhado (_), facilita a localização deles ao escrever consultas.
Data type Tipo de dados dos valores do parâmetro.
Mostrar em páginas Selecione as páginas em que esse parâmetro será exibido. A opção de configuração Selecionar tudo mostra o parâmetro em todas as páginas.
Origem Origem dos valores do parâmetro:
  • Valores fixos: Valores de filtro estáticos introduzidos manualmente.
  • Consulta: Valores introduzidos dinamicamente usando uma consulta KQL.
Valor padrão O valor padrão do filtro. O filtro começará sempre com o valor padrão na renderização inicial do painel.
Adicionar um valor "Selecionar tudo" Aplicável somente a parâmetro do tipo seleção única e seleção múltipla. Usado para recuperar os dados referentes a todos os valores do parâmetro. Esse valor deve ser criado na consulta para oferecer a funcionalidade. Para obter mais exemplos de criação dessas consultas, consulte Usar o parâmetro baseado em consulta de seleção múltipla.

Gerenciar parâmetros

Depois de selecionar Parâmetros na barra superior, você pode exibir a lista de parâmetros existentes. Em cada parâmetro cartão, selecione o widget de lápis para editar o parâmetro ou selecione o menu Mais [...] para Duplicar, Excluir ou mover o parâmetro.

Os seguintes indicadores podem ser exibidos no cartão de parâmetros:

  • Nome de exibição do parâmetro
  • Nomes de variáveis
  • Número de consultas nas quais o parâmetro foi usado
  • Páginas às quais o parâmetro está fixado

Os cartões de parâmetro podem ser ordenados arrastando e soltando ou usando a opção Mover para > e selecionando o novo local.

Captura de tela dos cartões de parâmetros de exemplo.

Usar parâmetros em sua consulta

Um parâmetro precisa ser usado na consulta para tornar o filtro aplicável para esse visual de consulta. Depois de definidos, você pode ver os parâmetros na página Consulta> barra superior do filtro e no intelliSense de consulta.

Observação

Se o parâmetro não for usado na consulta, o filtro permanecerá inativo. Depois que o parâmetro é adicionado à consulta, o filtro fica ativo.

Tipos de parâmetro

Há suporte para vários tipos de parâmetros dashboard, da seguinte maneira:

Os exemplos a seguir descrevem como usar diversos tipos de parâmetro em uma consulta.

Parâmetro de intervalo de tempo padrão

Por padrão, cada painel tem um parâmetro Intervalo de tempo. Ele aparece no painel como um filtro somente quando usado em uma consulta. Use as palavras-chave de parâmetro _startTime e _endTime para usar o parâmetro de intervalo de tempo padrão em uma consulta, conforme visto no seguinte exemplo:

StormEvents
| where StartTime between (_startTime.._endTime)
| summarize TotalEvents = count() by State
| top 5 by TotalEvents

Depois de salvo, o filtro de intervalo de tempo aparece no painel. Agora ele pode ser usado para filtrar os dados no cartão. Você pode filtrar o painel selecionando na lista suspensa: Intervalo de tempo (últimos x minutos/horas/dias) ou um Intervalo de tempo personalizado.

Captura de tela mostrando como filtrar usando o intervalo de tempo personalizado.

Parâmetros de valores fixos de seleção única

Parâmetros de valor fixo são baseados em valores predefinidos especificados pelo usuário. O exemplo a seguir mostra como criar um parâmetro de valor fixo de seleção única.

Criar um parâmetro de valores fixos de seleção única

  1. Selecione Parâmetros para abrir o painel Parâmetros e selecione Novo parâmetro.

  2. Preencha os detalhes da seguinte maneira:

    • Rótulo: Tipo de Evento

    • Tipo de parâmetro: seleção única

    • Nome da variável: _eventType

    • Tipo de dados: cadeia de caracteres

    • Fixar como filtro do painel: verificado

    • Fonte: valores fixos

      Neste exemplo, use os seguintes valores:

      Valor Nome de exibição do parâmetro
      Thunderstorm Wind Vento de tempestade
      Granizo Granizo
      Saturação de Flash Enchente
      Seca Seca
      Clima de Inverno Clima de inverno

    • Adicione um valor Selecionar tudo: desmarcado

    • Valor padrão: Vento de Tempestade

  3. Selecione Concluído para criar o parâmetro.

O parâmetro pode ser visto no painel lateral Parâmetros , mas não está sendo usado atualmente em nenhum visual.

Usar um parâmetro de valores fixos de seleção única

  1. Execute uma consulta de exemplo usando o novo parâmetro Event TypTope usando o nome da _eventType variável:

    StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType == _eventType
| summarize TotalEvents = count() by State
| top 5 by TotalEvents

    O novo parâmetro aparece na lista de parâmetros na parte superior do painel.

  2. Selecione valores diferentes para atualizar os visuais.

    Exibição de telas mostrando o resultado dos cinco estados principais.

Parâmetros de valores fixos de seleção múltipla

Parâmetros de valor fixo são baseados em valores predefinidos especificados pelo usuário. O exemplo a seguir mostra como criar e usar um parâmetro de valor fixo de seleção múltipla.

Criar parâmetros de valores fixos de seleção múltipla

  1. Selecione Parâmetros para abrir o painel Parâmetros e selecione Novo parâmetro.

  2. Preencha os detalhes conforme mencionado em Usar um parâmetro de valores fixos de seleção única com as seguintes alterações:

    • Rótulo: Tipo de Evento
    • Tipo de parâmetro: seleção múltipla
    • Nome da variável: _eventType

  3. Selecione Concluído para criar o parâmetro.

Os novos parâmetros podem ser vistos no painel lateral Parâmetros, mas não estão sendo usados atualmente em nenhum visual.

Usar um parâmetro de valores fixos de seleção múltipla

  1. Execute uma consulta de exemplo usando o novo parâmetro Tipo de Evento usando a _eventType variável .

    StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType in (_eventType) or isempty(_eventType)
| summarize TotalEvents = count() by State
| top 5 by TotalEvents

    O novo parâmetro aparece na lista de parâmetros na parte superior do painel.

  2. Selecione um ou mais valores diferentes para atualizar os visuais.

    Captura de tela mostrando como selecionar vários tipos de evento.

Parâmetros baseados em consulta de seleção única

Os valores de parâmetro baseados em consulta são recuperados durante o carregamento do painel executando a consulta de parâmetro. O exemplo a seguir mostra como criar e usar um parâmetro baseado em consulta de seleção única.

Criar um parâmetro baseado em consulta de seleção única

  1. Selecione Parâmetros para abrir o painel Parâmetros e selecione Novo parâmetro.

  2. Preencha os detalhes conforme mencionado em Usar um parâmetro de valores fixos de seleção única com as seguintes alterações:

    • Rótulo: Estado

    • Nome da variável: _state

    • Origem: Consulta

    • Fonte de dados: StormEventsSample

    • Selecione Editar consulta e insira a consulta a seguir. Selecione Concluído.

      StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType in (_eventType) or isempty(_eventType)
| summarize TotalEvents = count() by State
| top 5 by TotalEvents
| project State

    • Valor: Estado

    • Nome de exibição: Estado

    • Valor padrão: escolha um valor padrão

  3. Selecione Concluído para criar o parâmetro.

Usar um parâmetro baseado em consulta de seleção única

  1. A seguinte consulta de exemplo com o novo parâmetro State usa a _state variável :

    StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType in (_eventType) or isempty(_eventType)
| where State == _state
| summarize TotalEvents = count() by State
| top 5 by TotalEvents

    O novo parâmetro aparece na lista de parâmetros na parte superior do painel.

  2. Selecione valores diferentes para atualizar os visuais.

Parâmetros baseados em consulta de seleção múltipla

Os valores de parâmetro baseados em consulta são derivados no tempo de carregamento do painel executando a consulta especificada pelo usuário. O exemplo a seguir mostra como criar um parâmetro baseado em consulta de seleção múltipla:

Criar um parâmetro baseado em consulta de seleção múltipla

  1. Selecione Parâmetros para abrir o painel Parâmetros e selecione + Novo parâmetro.

    1. Preencha os detalhes conforme mencionado em Usar um parâmetro de valores fixos de seleção única com as seguintes alterações:
    • Rótulo: Estado
    • Tipo de parâmetro: seleção múltipla
    • Nome da variável: _state

  3. Selecione Concluído para criar o parâmetro.

Usar um parâmetro baseado em consulta de seleção múltipla

  1. A consulta de exemplo a seguir usa o novo parâmetro State usando a _state variável .

    StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType in (_eventType) or isempty(_eventType)
| where State in (_state) or isempty(_state)
| summarize TotalEvents = count() by State
| top 5 by TotalEvents

    Observação

    Este exemplo usa a opção Selecionar Tudo verificando se há valores vazios com a função isempty().

    O novo parâmetro aparece na lista de parâmetros na parte superior do painel.

  2. Selecione um ou mais valores diferentes para atualizar os visuais.

Parâmetros de texto livre

Os parâmetros de texto livre não contêm nenhum valor. Eles permitem que você introduza seu próprio valor.

Criar um parâmetro de texto livre

  1. Selecione Parâmetros para abrir o painel Parâmetros e selecione + Novo parâmetro.

  2. Preencha os detalhes da seguinte maneira:

    • Rótulo: Estado
    • Tipo do parâmetro: texto livre
    • Nome da variável: _state
    • Tipo de dados: cadeia de caracteres
    • Valor padrão: nenhum valor padrão

Usar um parâmetro de texto livre

  1. Execute uma consulta de exemplo usando o novo parâmetro State usando o nome da _state variável:

    StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType in (_eventType) or isempty(_eventType)
| where State contains _state
| summarize TotalEvents = count() by State
| top 5 by TotalEvents

Parâmetros da fonte de dados

Depois de adicionar fontes de dados ao dashboard, você pode criar um parâmetro que seleciona uma ou mais das fontes de dados disponíveis. Esse parâmetro pode ser usado em blocos e outros parâmetros.

Criar um parâmetro de fonte de dados

  1. Selecione Parâmetros para abrir o painel Parâmetros e selecione + Novo parâmetro.

  2. Preencha os detalhes da seguinte maneira:

    • Rótulo: Origem
    • Tipo de parâmetro: fonte de dados
    • Mostrar em páginas: Selecionar tudo
    • Valores: selecionar todos
    • Valor padrão: StormEventsSample

  3. Selecione Concluído.

O novo parâmetro agora está visível na lista de parâmetros na parte superior do painel.

Usar um parâmetro de fonte de dados

  1. Navegue até a consulta de um bloco novo ou existente.

  2. Em Origem, selecione o nome do novo parâmetro em Parâmetros de fonte de dados. Para o parâmetro criado acima, selecione Cluster.

  3. Selecione Aplicar alterações.

  4. Use o parâmetro Cluster para alterar a fonte de dados dessa consulta conectada.

Parâmetros de filtros cruzados

Os filtros cruzados permitem que você selecione um valor em um visual, e todos os visuais do painel, como gráficos de linha ou de dispersão, são filtrados para mostrar apenas os dados relacionados. O uso de filtros cruzados alcança o mesmo resultado que selecionar o valor equivalente para o parâmetro na lista de parâmetros na parte superior do painel.

Definir filtros cruzados

Para criar um filtro cruzado, você deve ativar a opção no visual e especificar o parâmetro usado para filtrar os dados.

  1. Navegue até a consulta do bloco em que você deseja adicionar filtros cruzados.

  2. Selecione Visual.

  3. No painel direito, selecione Interações e, em seguida, ative os filtros cruzados.

  4. Opcionalmente, especifique o Tipo de interação . O padrão é Point , em que você pode selecionar um valor no visual. Para selecionar um intervalo de valores, como em um gráfico de tempo, selecione Arrastar.

  5. Especifique a coluna usada para fornecer o valor e um parâmetro usado para filtrar a consulta.

    Importante

    A coluna e o parâmetro precisam ser do mesmo tipo de dados.

Captura de tela da página editar visual, mostrando a guia interações.

Interagir com seus dados usando filtro cruzado

Depois que o filtro cruzado é definido, você pode usá-lo para interagir com seus dados. Em visuais onde você definiu filtros cruzados, você pode selecionar pontos de dados e usar os valores deles para filtrar as páginas do painel atual. Para visuais de tabela, selecione pontos de dados clicando com o botão direito do mouse na célula relevante e, em seguida, no menu de contexto, selecione Filtro cruzado.

Captura de tela de um visual de tabela mostrando a opção de menu de contexto de filtro cruzado.

Você pode redefinir o filtro cruzado selecionando Redefinir na parte superior do visual em que ele foi selecionado.

Captura de tela de um visual de tabela mostrando o botão redefinir.

Usar detalhamentos como parâmetros de painel

Com o detalhamento, você pode selecionar um valor em um visual e usá-lo para filtrar os visuais em uma página de destino no mesmo painel. Quando a página de destino é aberta, o valor é pré-selecionado nos filtros relevantes. Os visuais na página, como gráficos de linha ou dispersão, são filtrados para mostrar apenas dados relacionados.

Definir um detalhamento

Para criar um detalhamento, você deve primeiro ativá-lo no visual e, em seguida, adicionar um ou mais detalhamentos conforme necessário.

  1. Edite o visual onde você deseja adicionar um detalhamento. Verifique se a guia Visual está selecionada.

  2. No painel direito, selecione Interações e, em seguida, ative o detalhamento.

    Captura de tela da página de detalhamento mostrando a opção ativar.

  3. Em Detalhamento, selecione Criar novo e especifique as informações a seguir. Opcionalmente, selecione Adicionar outro par para adicionar vários parâmetros para uma página de destino. Repita esta etapa para adicionar detalhamentos a outras páginas no painel atual usando parâmetros diferentes.

    Campo Descrição
    Página de destino Uma ou mais páginas de destino para detalhar usando os parâmetros definidos.
    Coluna A coluna do resultado da consulta a ser usada como o valor de um parâmetro na página de destino.
    Parâmetro O parâmetro usado para filtrar visuais na página de destino usando o valor da coluna.
    Observações Descrição curta opcional.

    Importante

    A coluna e o parâmetro precisam ser do mesmo tipo de dados.

Interagir com seus dados usando detalhamentos

Depois que os detalhamentos forem definidos, você poderá usá-los para interagir com seus dados. Para fazer isso, em visuais ou tabelas onde você definiu um detalhamento, clique com o botão direito do mouse em um ponto de dados e, em seguida, selecione Detalhar>página de destino. Os valores do ponto de dados serão usados como parâmetros para filtrar os visuais na página de destino.

Captura de tela de um visual dashboard, mostrando a interação de detalhamento.

Para retornar à página de origem, no canto superior direito da página de destino, selecione Redefinir. Todos os filtros atribuídos pelo detalhamento serão redefinidos.

Usar a pesquisa de filtro para filtros de seleção única e múltipla

Em filtros de seleção única e múltipla, digite o valor que você deseja. O filtro é atualizado para mostrar apenas os valores que correspondem ao termo de pesquisa.

Conteúdo relacionado